API

The endpoint reference — paths, parameters, request and response shapes — is generated from the running service and lives at /reference. So are the conventions that apply across every endpoint: status codes, the error format, pagination, conditional requests and rate limits.

These pages cover what the specification cannot describe. For version policy, migration and the record of changes, see Versioning.

Trying an endpoint

/reference has a built-in client. Sign in with the button in the header and it will attach your token to any request you send from the page, so you can see a real response before writing code.

Keeping clients working

Two habits that survive most changes:

• Ignore unknown response fields. New ones can appear within a major version; a client that rejects them will break on an additive change.
• Follow the next link when paging rather than incrementing offset yourself, so your paging stays correct if the defaults move.