Use the {{brand}} API reference

Read every {{brand}} API route an access token can call, and try one with your own token.

In short

The reference at /developers/api lists every {{brand}} API route an access token can call, grouped by module, with the scope each needs. You can try a route there with your own token.

Before you start

Who: signed in. A personal access token; try-it sends real requests in your own workspace.
Plan: every plan; sends count as usual.
First: make an access token in Settings, Access tokens, with only the scopes you need.

Steps

Make a personal access token in "Settings", under "Access tokens", with only the scopes you need.
Open the reference at /developers/api and paste the token at the top. Press "Use this token".
Open a route, press "Try it", fill in the path values and press "Send".

Result: the answer appears under the route.

Good to know

Routes that need a person in the app are not listed.
Each route lists the fields it answers with. A route whose answer is not described says "No fields are described for this answer."
The reference is a file made when {{brand}} is built; the running API does not serve a description of itself.
The token stays in the memory of that browser tab. It is never saved, is sent only to the {{brand}} API, and reloading the page forgets it.
A request that changes data asks you to confirm first: it is a real request against your own workspace.

If something goes wrong

The route answers 403: the token lacks the scope the route needs. Make a token with it.
The token stopped working: it expired or was revoked. Make a new one.