Base URL
All API requests are made to:Authentication
The API uses OAuth 2.0 client credentials for authentication. You’ll exchange yourclient_id and client_secret for a Bearer token, then include it in every request.
See the Authentication guide for the full walkthrough.
Versioning
The API is versioned via the URL path (/v1). Breaking changes will be introduced under a new version number. Non-breaking additions (new fields, new endpoints) may be added to the current version without notice.
Response format
All resource responses use the JSON:API serialization format:pagination object alongside data:
Errors
Errors follow the RFC 9457 Problem Details format:request_id field is useful when contacting support.
Rate limits
Exceeding either limit returns a
429 Too Many Requests response.
Scopes
Access tokens can have the following scopes:
You can omit
scope if you only need read access and your OAuth application is scoped to read or write — it defaults to read. If your application has the read write scope, you must specify scope explicitly. See Authentication for details.