Developer API
The developer API lets you access the platform programmatically using a scoped API token.
Base URL
Section titled “Base URL”https://your-app.com/apiEvery endpoint in this reference is versioned under /v1 — for example, GET /api/v1/me.
Authentication
Section titled “Authentication”Requests authenticate with a bearer token you generate from your dashboard. Send it on every request:
Authorization: Bearer YOUR_TOKENSee Authentication for how to create a token and what each scope grants.
Requirements
Section titled “Requirements”Your organization must be on a qualifying plan to use the developer API — by default the Enterprise plan. If your plan doesn’t qualify, the API responds with 403 Forbidden.
Rate limits
Section titled “Rate limits”Each token has a monthly request limit — 1,000 requests per calendar month by default. When a token exceeds its limit the API responds with 429 Too Many Requests and a Retry-After header (seconds until the limit resets at the start of the next month). Need a higher limit? Contact us to request an increase.
Errors
Section titled “Errors”Errors return the matching HTTP status code and a JSON body:
{ "message": "A human-readable description of what went wrong." }| Status | Meaning |
|---|---|
401 Unauthorized | Missing or invalid token. |
403 Forbidden | Plan doesn’t qualify, or the token lacks the required scope. |
404 Not Found | The requested resource doesn’t exist. |
429 Too Many Requests | Monthly request limit exceeded — see the Retry-After header. |
Endpoints
Section titled “Endpoints”Endpoints are grouped by the resource they act on.
GET /v1/me— the authenticated user.