API ReferenceOverview

Overview

Last updated 2026-02-07

All customer endpoints are under /v1/* and use API key auth.

Base headers

http
Authorization: Bearer <api_key>
Content-Type: application/json

Write safety

For write endpoints, send Idempotency-Key when possible.

Response shape

Success payloads are endpoint-specific. Errors use a standard shape:

json
{
  "error": {
    "code": "SOME_CODE",
    "message": "Human readable message",
    "details": {}
  }
}

See /docs/api-reference/errors and /docs/api-reference/scopes.