PreflightAPI Documentation

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 — Collection endpoints return a paginated wrapper. Use the cursor query parameter to fetch subsequent pages. The limit parameter controls page size (1–500, default 100).
• Structured errors — Backend errors return a structured response with a machine-readable code, human-readable message, and a traceId for support. Gateway errors (auth, rate limit, quota) use a simpler format.

Paginated responses follow this shape:

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

Response Caching

GET requests are cached at the API gateway level to reduce latency. Cache duration varies by data type to balance freshness with performance. Cached responses are identical to fresh responses and still count toward your rate limit and monthly quota.

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.