API overview

A REST API over HTTPS. JSON in, JSON out.

Base URL

https://api.example.com/v1

Versioning

The version lives in the URL path. We bump the major version only for backwards-incompatible changes; additive changes (new endpoints, new fields on responses) are made within the existing version.

Pagination

List endpoints use cursor-based pagination:

GET /things?limit=50&starting_after=thing_01HXY...

Responses include has_more and the cursor for the next page.

What's next

• Authentication — how to authorize requests.
• Add an endpoints/ folder under api-reference/ for per-endpoint docs.