Skip to main content
Every call carries a bearer token. You get it with two values: your Client ID and your API key. Access says where they come from. This page gets you authenticated and nothing more: the two calls, the shape they return, and how they fail. The endpoint itself, with every field and a live “Try it”, is Get access token.

Get a token

Send the Client ID and the API key in the body. This call needs no other credential. Your API key is not the key you used to send in x-api-key. Both were renamed. The old names maps each to the new one.
The token comes back nested under data:
Read the lifetime from data.expires_in rather than assuming it. It is set per account, so a number you hard-code from one environment can be wrong in another.

Call the API

Send the token in the Authorization header of every other call.
Reuse the token until it is close to expiry, then get a new one. Asking again before then can return the same token, with less time left in expires_in. Your API key only ever goes to the token call.

If you send password and x-api-key

Your integration keeps working. Nothing has to change.
  • password is the older name for api_key, and it is still accepted. Send one or the other.
  • The x-api-key header carries your legacy key. It is optional. If you send it, send your own. Another account’s legacy key is refused.
  • A value in x-api-key that is not a legacy key is ignored. The token is what authenticates the call.
Your API key used to be called the client password. Your legacy key used to be called the API key. If your dashboard still shows Password, that value is your API key.

When it fails

Getting a token: Calling the API: Read the status code and code rather than the message.

Your first call

Create something and read it back.