API reference
How the generated SETTO External API reference works — one page per operation, a Try it panel you can paste a token into, and the raw OpenAPI document.
The pages in this section are generated from the SETTO External API's OpenAPI document, so they cannot drift from the API: one page per operation, with its path, method, every parameter, the security scheme and the response schema. Each page also carries a Try it panel that fires a real request from your browser, so you can see a live payload without leaving the docs. If you are looking for worked examples and advice rather than an exhaustive parameter list, read the guides instead.
The operations
| Operation | Method and path | Guide |
|---|---|---|
getMe | GET /v1/external/me | Quickstart |
listTournaments | GET /v1/external/tournaments | List tournaments |
getTournament | GET /v1/external/tournaments/{idx} | Get a tournament |
listDivisions | GET /v1/external/tournaments/{idx}/divisions | List divisions |
listTeams | GET /v1/external/tournaments/{idx}/teams | List teams |
getRound | GET /v1/external/rounds/{idx} | Get a round |
Pages are grouped by OpenAPI tag — Organization, Tournaments, Divisions, Teams, Rounds — which is also how the sidebar is ordered.
Using "Try it"
Every operation page has a panel where you can fill in the path and query parameters and send the request.
- Open the Authorization field and paste an organization API token
(
setto_live_…). The panel uses theapiTokenbearer scheme declared in the spec. - Fill in
idx— a real tournament or round UUID from your own organization. - Send. The response comes back with its status, headers and body.
The request leaves your browser
The playground calls the SETTO API directly from your browser; there is no proxy in front of it, and nothing is stored on this site's servers. Even so, a token pasted into a web form is a token that has been in a web form — use a short-lived one, or revoke it afterwards from the organizer dashboard. See Authentication.
If a request fails with a network or CORS error rather than an HTTP status, the token never left your browser — check the token and the URL and try again.
The raw OpenAPI document
The same document that generates these pages is published at
/openapi.json. Point a client generator, a Postman import or
an AI agent at it:
curl -s https://docs.setto.io/openapi.json -o setto-external-api.jsonIts servers[0].url is filled in at request time from the API base URL this site
is configured against, so the URLs in a generated client are correct without
editing.
Related
- Authentication — before you paste a token anywhere.
- Errors — every status and code the reference lists.
- Rate limits — the headers on every response.