The host for API requests is
All requests must be made over HTTPS. HTTP is not supported.
You must provide an authorization header as described in Authentication.
Depending on the resource, we support the following HTTP verbs:
|GET||Retrieve a resource or group of resouces|
|POST||Create a new resource|
|PUT||Update an existing resource|
|DELETE||Delete an existing resource|
|OPTIONS||View allowed verbs against a specific resources|
The API provides JSON responses. The accept header is not currently
required, though it may be required in the future. If not set, the
API will use
When you send an array of data in a
GET request, you will include the parameter multiple times on the URL. We do not require that you add brackets to the parameter name.
Example Array in a GET request
When submitting data to a resource via
PUT, you must
submit your payload in JSON.
1 2 3 4 5 6
GET resources allow for retrieval of information in batches. We
will provide the query args in the resource documentation when available
When requesting multiple items, we will default the request limit to 500 items. You can specify a different limit but cannot not exceed the default limit.
Resources documented will display a bolded list of available paginated parameters if available.
Below is a basic pagination example. In the resource documentation, we will only provide the bolded list of available parameters.
When information is batched, a Link Header will be provided in the response.
|limit||The number of records to return|
|offset||The number of records to skip|
Some resources allow for you to search by a specific field. Other resources require you to append a parameter to the URI.
In this example, we will display a paginated uri example, searching for
resources where the email contains
Below is a general overview of what resource objects are returned on successful Web API requests.
|Verb||Resource object returned|
|GET||A single resource object or array of resource objects|
|PATCH||The updated resource object is returned|
|PUT||The updated resource object is returned|
|DELETE||No content is returned|
|POST||The newly created resource object is returned|