Developer API/API reference
API reference
Generated OpenAPI reference and the API v1 route index.
Use the interactive reference to inspect parameters and response fields or send a test request:
The raw document can be used with OpenAPI client generators and contract-testing tools.
Route index
| Resource | Routes |
|---|---|
| Organisation | GET /organisation |
| Events | GET /events, GET /events/{eventId} |
| Stages | GET /events/{eventId}/stages, GET /events/{eventId}/stages/{stageId} |
| Groups | GET /events/{eventId}/groups, GET /events/{eventId}/groups/{groupId} |
| Rounds | GET /events/{eventId}/rounds, GET /events/{eventId}/rounds/{roundId} |
| Participants | GET /events/{eventId}/participants, GET /events/{eventId}/participants/{participantId} |
| Matches | GET /events/{eventId}/matches, GET /events/{eventId}/matches/{matchId} |
| Standings | GET /events/{eventId}/standings |
| Invitations | GET /events/{eventId}/invitations, GET /events/{eventId}/invitations/{invitationId} |
| Broadcast | GET /events/{eventId}/broadcast |
| Playdays | GET /events/{eventId}/playdays, GET /events/{eventId}/playdays/{playdayId} |
| Users | GET /users/{userId} |
| Maps | GET /maps |
| Realtime | GET /gateway with a WebSocket upgrade |
Competition collections accept stageId and, where applicable, groupId query
filters. The generated reference describes the exact accepted parameters and
response fields.
User privacy
GET /users/{userId} resolves only users who participate in an event owned by
the key's organisation. Responses contain public profile fields only. Email
addresses and authentication data are never returned.