Base URLs
Authentication
Every/v1 endpoint except GET /v1/health requires a bearer access token. Get one with the OAuth
2.0 client_credentials grant at POST /oauth/token, then send it as
Authorization: Bearer <token>. See Authentication and Scopes.
Endpoints
Read is the
all:read scope and Write is all:write.
Conventions
- Pagination: list endpoints return cursor-based pages. See Pagination.
- Errors: JSON body with a stable
code. See Errors. - Rate limits: separate limits for token, read, and write requests. See Rate limits.
- Versioning: only additive changes within
/v1. See Versioning.
Download the spec
Download the contract at/api-reference/openapi.yaml. Use it to
generate a client or import it into your API tool.