Skip to main content
GET
/
game
/
matches
/
{matchId}
/
rosters
Get a match's team rosters
curl --request GET \
  --url https://teambattles.gg/api/v1/game/matches/{matchId}/rosters \
  --header 'Authorization: Bearer <token>'
{
  "creatorTeamId": "<string>",
  "acceptedTeamId": "<string>",
  "creatorRoster": [
    {
      "userId": "<string>",
      "teamId": "<string>",
      "username": "<string>",
      "name": "<string>",
      "isCheckedIn": true
    }
  ],
  "acceptedRoster": [
    {
      "userId": "<string>",
      "teamId": "<string>",
      "username": "<string>",
      "name": "<string>",
      "isCheckedIn": true
    }
  ],
  "timestamp": "<string>"
}

​
Permission Required

This endpoint requires the game.lifecycle permission with read access. Your API key must be a game-developer key bound to a game. The binding asserts the match belongs to your bound game before the handler runs: a key bound to a different game, or a non-developer key, receives a 403 error_game_scope_mismatch.

​
Access / Membership Rules

The {matchId} must resolve to a match in your bound game. An unknown match returns 404 error_match_not_found.

​
What’s Returned

Returns { creatorTeamId, acceptedTeamId, creatorRoster, acceptedRoster, timestamp }. acceptedTeamId is null when the match is unaccepted. Each roster is an array of players, where each entry carries userId, teamId, username, name, and isCheckedIn. acceptedRoster is empty until the match is accepted.

Authorizations

​
Authorization
string
header
required

Send your API key as: Authorization: Bearer tb_

Path Parameters

​
matchId
string
required

Match ID.

Response

Team rosters grouped by creator and accepted team.

Team rosters for a match, grouped by creator and accepted team.

​
creatorTeamId
string
required

ID of the team that created the match.

​
acceptedTeamId
string | null
required

ID of the team that accepted the match, or null if unaccepted.

​
creatorRoster
object[]
required

Players on the creator team.

​
acceptedRoster
object[]
required

Players on the accepted team (empty when unaccepted).

​
timestamp
string
required

Server response time (ISO 8601).