Get the authoritative match roster
Returns the authoritative roster of players admitted to the match backing this server. Game servers call this (with their server API key and their own INSTANCE_ID) to know exactly which players to admit — this is the source of truth for admission and fixes reconnect / “denied by proxy” edge cases.
The response includes per-team slots, total capacity, current_players, backfill state, and a monotonically increasing roster_version. Poll roster_version cheaply to detect roster changes (e.g., when a backfill joiner is admitted).
Only available for servers that back a match (created through matchmaking/lobbies).
Authorizations
Path Parameters
Server instance ID (the game server's own INSTANCE_ID).
Response
Authoritative roster for the match backing this server.
Authoritative roster for a running match. Game servers poll this (by instance_id, with a server API key) to know which players to admit.
Identifier of the match backing this server.
Server instance backing this match.
Match lifecycle status. "in_game": active. "locked": no further joiners. "completed": ended.
in_game, locked, completed Total admissible players across all teams (teams × playersPerTeam).
Number of players currently on the roster.
Whether the match is currently accepting backfill joiners.
ISO 8601 timestamp after which backfill closes. Null if no window is active.
Monotonically increasing version bumped on every roster change. Poll this to detect updates cheaply.
Per-team slot map keyed by team name.
Authoritative flat list of admitted players. The game server uses this to admit connecting players.