Current Version

The current version of our API is v2. We do not require you to specify a version for every endpoint. We’ve documented the endpoints that require a specific version to be provided.

More about versions

Root Endpoint

The root endpoint of the API is: http://rest.brand-domain.tld.

If your environment is configured with HTTPS, we strongly recommend using that protocol.


We recommend using our API with Basic Auth due to its relative simplicity, but we do also support OAuth 1.0.


For GET requests, parameters should be provided in the query string.

For POST and PUT requests, parameters should be encoded as JSON. The Content-Type should be specified as application/json.

Note: Our API does support request bodies with a Content-Type of application/x-www-form-urlencoded. However, we recommend sending as JSON.

Client Errors

Sending invalid data will result in a 400 Bad Request response.

User Agent Required

Please provide a valid User-Agent header when making requests to the API.