client_id and client_secret for a short-lived JWT bearer token.
Flow
Request
POST /api/auth
Response
JWT claims
The access token is an HS256 JWT with these claims:Token validity
Access tokens are valid for 600 seconds (10 minutes). After expiry, callPOST /api/auth again.
Response headers
Using the token
Include the token on all protected requests:Using the API playground
The API Reference includes an interactive playground on each endpoint. You do not need to paste your bearer token on every request — set it once and reuse it across endpoints.1
Choose an environment
Only Development is available in the server dropdown on API Reference pages right now; Staging and Live will be added once they have working base URLs. Your selection is remembered while you browse other endpoints in the same browser.
2
Get an access token
Open Authenticate (
POST /api/auth) in the API Reference. Run the request with your client_id, client_secret, and scopes. Copy the access_token from the response.3
Authorize once
In the API Reference, open the Auth (or Authorize) section. Paste your
access_token into the bearer token field. You do not need to include the Bearer prefix — the playground adds it automatically.4
Try any endpoint
Navigate to any protected endpoint and use Try it. The playground sends your saved token on every request until you clear it or it expires.
5
Refresh when expired
Access tokens expire after 10 minutes. When requests start returning
401, call POST /api/auth again and update the token in the Auth section.The playground stores your selected environment and bearer token in your browser’s local storage for this documentation site. They persist when you move between endpoints and refresh the page, but are not shared across browsers or devices.
Failed authentication alerts
After 3 consecutive failed authentication attempts for the same API credential, an email notification is sent to the tenant administrators. The API credential is not automatically disabled. If you receive repeated failure alerts, verify yourclient_id and client_secret, confirm you are calling the correct environment base URL, and rotate the credential if the secret may have been compromised.
Security notes
- Never expose
client_secretin client-side code or public repositories - Store credentials in environment variables or a secrets manager
- Request only the scopes your integration needs

