v20

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-011984401.2 MB
Leaderboards

Get a team's leaderboard rank

Resolves a single team by slug or ID and returns its 1-indexed rank on the public team leaderboard. sortBy selects the ranking field: wins (default), winRate, or experience. Pass gameSlug to rank within one game's leaderboard; omit it for the global (all-games) board. An unknown gameSlug returns 404. rank is null when the team is excluded from the leaderboard (private or disabled) and also when the team ranks beyond the internal scan window, since the rank is a bounded best-effort computation rather than a full-table sort. A missing or inactive team returns 404; an active but excluded team returns 200 with rank null. Requires teams.profile:read.

get/leaderboards/teams/{identifier}/rank

Path parameters

identifierstring required

Team slug or Convex team ID.

Team slug or Convex team ID.

Query parameters

sortBy'wins' | 'winRate' | 'experience'

Supported leaderboard sort field.

gameSlugstring

Response

Team rank.

idstring required

Resolved entity ID.

rankinteger nullable required
sortBy'wins' | 'winRate' | 'experience' required

Supported leaderboard sort field.

gameSlugstring nullable
timestampstring required