Passing Arguments

A key part of using the API is sending data to the requests that you wish to make. Each endpoint implements arguments which are outlined in this documentation. This page explains how you should submit data for these arguments with your requests. How you pass arguments will depend on the request method.

GET requests

When you wish to provide arugments to a GET request, you should do so by providing them as querystring parameters. For example:

https://.../path?name=Joe+Bloggs&organization[id]=org_abcdef123

POST PATCH PUT DELETE requests

Arguments for these types of requests must be provided as JSON in the body of the request. For example:

{
  "name": "Joe Bloggs",
  "age": 38,
  "enabled": true,
  "organization": {
    "id": "org_abcdef123"
  }
}