---
title: "List the top players of a game set (leaderboard)"
method: GET
path: "/gameset/plays/gamesets/{gameSetId}/top-players"
tags: ["gameset-plays"]
---

# List the top players of a game set (leaderboard)

`GET /gameset/plays/gamesets/{gameSetId}/top-players`

## Request

- Base URL: `https://api.versusgame.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.versusgame.com/gameset/plays/gamesets/{gameSetId}/top-players`
- Auth: none declared
- TypeScript: <https://skmtc.dev/versusgame/apis/versusgame-api/docs/gameset/plays/gamesets/:gameSetId/top-players/get.ts> (a function with typed inputs; its response is checked against the schema)

Ranked by the most games played for that GameSet.

## Path parameters

- `gameSetId` string, required

## Query parameters

- `limit` number
- `cursor` string
- `withExternalId` boolean

## Response `200`

Ranked list of top players with usernames

- TopPlayersForGameSetResponseEntity
  - `items` RankedPlayerStandings[], required
    - `userId` string, required: Usually a UUID, but older users may have a numberic id
    - `externalId` string: The player's externalId
    - `username` string, required: The player's username
    - `avatarUrl` string, required: The player's avatar URL
    - `gamesPlayedCount` number, required: Total games played in that GameSet attempt
    - `correctAnswerCount` number, required: Total correct answers in that GameSet attempt
  - `cursor` string

---

[API](https://skmtc.dev/versusgame/apis/versusgame-api.md) - [All operations](https://skmtc.dev/versusgame/apis/versusgame-api/llms.txt) - [OpenAPI document](https://skmtc.dev/versusgame/apis/versusgame-api/revisions/e86f45ae5f7c?raw)