Skip to content



A basic understanding of OAuth is required. You can read more at

Before you start you will need a Client ID and Secret.

You will need to create an application first.

OAuth Authentication

Authentication to the api is handled using OAuth 2.0 via the Client Credentials grant type.

The URLs for the auth server are as follows:

Generating a Token

An OAuth token is generated using the client credentials grant flow.

An HTTP POST request needs to be sent to

The following fields need to be included in the request:

  • grant_type: client_credentials
  • client_id: YOUR_CLIENT_ID
  • client_secret: YOUR_CLIENT_SECRET

Upon successful response you will receive a JSON response with an access_token. You can then use the token for authorization with the API.

cURL Example

Terminal window
curl --request POST \
--url '' \
--header 'content-type: application/x-www-form-urlencoded' \
--data grant_type=client_credentials \
--data client_id=YOUR_CLIENT_ID \
--data client_secret=YOUR_CLIENT_SECRET


Successful authentications return a JSON an access_token.