API reference overview

Generated endpoint documentation and the API v1 route index.

Use the first-party reference to inspect each endpoint, its parameters, request examples, response states, and generated schemas:

The raw document can be used with OpenAPI client generators and contract-testing tools.

Route index

ResourceRoutes
OrganisationGET /organisation
EventsGET /events, GET /events/{eventId}
StagesGET /events/{eventId}/stages, GET /events/{eventId}/stages/{stageId}
GroupsGET /events/{eventId}/groups, GET /events/{eventId}/groups/{groupId}
RoundsGET /events/{eventId}/rounds, GET /events/{eventId}/rounds/{roundId}
ParticipantsGET /events/{eventId}/participants, GET /events/{eventId}/participants/{participantId}
MatchesGET /events/{eventId}/matches, GET /events/{eventId}/matches/{matchId}
StandingsGET /events/{eventId}/standings
InvitationsGET /events/{eventId}/invitations, GET /events/{eventId}/invitations/{invitationId}
BroadcastGET /events/{eventId}/broadcast
PlaydaysGET /events/{eventId}/playdays, GET /events/{eventId}/playdays/{playdayId}
UsersGET /users/{userId}
MapsGET /maps
RealtimeGET /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.