Authentication

The Token APIs are secured by generated APP credentials and JWT Bearer Tokens:

  • Scoped to a single App acting on behalf of a single Organization

  • Revoked immediately by deleting the App

Generating APP credentials

Use the developer portal to create a new App profile, or delete/revoke an existing App. Navigate to "Applications", then click "+ New Application"

Generating a JWT Bearer Token

JWT Bearer Token authenticates requests on behalf of your developer App.

This authentication method requires for you to pass a Bearer Token with your request, which you can generate within the Keys section of your developer Apps.

To use this authentication method, you'll need a bearer token, which you can generate by passing your app key and secret through the POST auth/token endpoint.

As a result you'll receive a response similar to this:

Once you have your JWT Bearer Token you can start interacting with any of the Token APIs.

When making an API call, supply the JWT as a Bearer token in the Authorization header:

Here is an example of what a API request looks like. You must replace $BEARER_TOKEN with the Bearer Token that you generate in the previous step, and have the proper access for this request to work:

API calls using JWT Bearer Token are rate limited per endpoint at the App-level.

Debugging a JWT Bearer Token

To see detailed info for an access token go to the Developer Portal->Developer tools->Access token debugger and enter your JWT Token.

If the token is valid you'll receive a response similar to this:

Last updated

Was this helpful?