Conventions

The API follows the same handful of patterns everywhere, so once you've used one resource you can predict the rest.

URL patterns

Update fields with PATCH /resource/:id and send only what changed. Actions are reserved for things that do something rather than edit a field — verifying a domain, rotating a token.

Pagination

List endpoints return a page of results with cursors:

{
  "result": [],
  "next_cursor": "opaque-string-or-null",
  "prev_cursor": "opaque-string-or-null"
}

Pass limit (default 50, maximum 200) and cursor as query parameters. Treat cursors as opaque — pass back exactly what you received, and stop when next_cursor is null.

Errors

Failures use standard HTTP status codes with a consistent body:

{
  "error": {
    "message": "human readable explanation",
    "code": "machine_code"
  }
}

Branch on code, and surface message when you need to show something to a person.

OpenAPI

The machine-readable description is available at GET /schema/openapi.yml and GET /schema/openapi.json — useful for generating clients or importing into API tooling.