Skip to main content
GET
Get the authoritative match roster

Authorizations

api-key
string
header
required

Path Parameters

instance_id
string
required

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.

match_id
string
required

Identifier of the match backing this server.

instance_id
string
required

Server instance backing this match.

status
enum<string>
required

Match lifecycle status. "in_game": active. "locked": no further joiners. "completed": ended.

Available options:
in_game,
locked,
completed
capacity
integer
required

Total admissible players across all teams (teams × playersPerTeam).

current_players
integer
required

Number of players currently on the roster.

backfill_open
boolean
required

Whether the match is currently accepting backfill joiners.

backfill_deadline
string<date-time> | null
required

ISO 8601 timestamp after which backfill closes. Null if no window is active.

roster_version
integer
required

Monotonically increasing version bumped on every roster change. Poll this to detect updates cheaply.

teams
object
required

Per-team slot map keyed by team name.

roster
object[]
required

Authoritative flat list of admitted players. The game server uses this to admit connecting players.