docs API

Your first request#

Every call carries a bearer token issued from your docs dashboard, and responses come back as JSON unless a page here says otherwise.

curl https://api.example.com/v1/items \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Accept: application/json"

Swap api.example.com for the base URL shown in your dashboard, and API_TOKEN for a token you created there. If that call answers, the rest of this documentation is variations on it: a different path, a different method, a body.

What is on these pages#

Authentication explains where tokens come from and how to keep them out of a repository. Quickstart walks the first call end to end, including the part where it fails. Endpoints is the table to keep open in a second tab. Errors covers status codes, the error body and what is worth retrying.

Conventions#

Rules that hold across every endpoint belong here, stated once, so the reference pages never repeat them: how the version in the path is pinned, how long lists are paged, which timezone timestamps use, what an identifier looks like. Readers assume anything left unstated, and they tend to assume wrong — a caller who guesses your pagination writes a loop that quietly stops at the first page.

Write the rules down in the order a caller meets them, not in the order you built them.

Next steps#

• Quickstart — a working call in a few minutes.
• Authentication — get a token and send it correctly.
• Endpoints — every route in one table.