Overview

Base URL

API Conventions

• REST + JSON — All endpoints accept and return JSON. Content type is always application/json.
• Versioned — The current API version is v1, included in every URL path (/api/v1/...).
• Cursor-based pagination — Endpoints that can return large result sets use a paginated wrapper with bidirectional navigation. Use the cursor query parameter with either nextCursor or previousCursor to page forward or backward. The limit parameter controls page size (1–500, default 100).
• Structured errors — All errors — gateway and backend — return a unified response format with a machine-readable code, human-readable message, and a traceId for support. Validation errors include field-level details.
• Response caching — GET responses are cached at the API gateway. Cache duration varies by data type (2–15 minutes). See the rate limits page for the full cache duration table.

Paginated responses follow this shape:

{
  "data": [ ... ],
  "pagination": {
    "nextCursor": "eyJpZCI6MTAwfQ==",
    "hasMore": true,
    "previousCursor": null,
    "hasPrevious": false,
    "limit": 100
  }
}

Endpoint Access by Plan

Not all endpoints are available on every plan. Requesting an endpoint your plan doesn't include returns a 403 Forbidden response. See pricing for full plan details.