Skip to main content
GET
/
teams
/
{identifier}
Get a team profile
curl --request GET \
  --url https://teambattles.gg/api/v1/teams/{identifier} \
  --header 'Authorization: Bearer <token>'
{
  "team": {
    "id": "<string>",
    "name": "<string>",
    "isMember": true,
    "createdAt": "<string>",
    "slug": "<string>",
    "tag": "<string>",
    "avatarUrl": "<string>",
    "description": "<string>",
    "bannerUrl": "<string>",
    "gameId": "<string>",
    "organizationId": "<string>",
    "memberCount": 4503599627370495,
    "wins": 4503599627370495,
    "losses": 4503599627370495,
    "draws": 4503599627370495,
    "matchesPlayed": 4503599627370495,
    "experience": 1
  },
  "timestamp": "<string>"
}

​
Permission Required

Team profile reads require teams.profile. Team member roster reads require teams.roster.
  • GET /teams/{identifier}
  • GET /teams/{identifier}/members
Private team rosters are only returned to active team members.

Authorizations

​
Authorization
string
header
required

Send your API key as: Authorization: Bearer tb_

Path Parameters

​
identifier
string
required

Team slug or Convex team ID.

Response

Team profile.

Envelope containing team plus a response timestamp.

​
team
object
required

API-safe team profile.

​
timestamp
string
required

ISO 8601 timestamp.