Sign in
latestOpenAPI 3.0.02026-08-10239286205.0 KB

e86f45ae5f7c

gameset-plays

List the top players of a game set (leaderboard)

Ranked by the most games played for that GameSet.

get/gameset/plays/gamesets/{gameSetId}/top-players

Path parameters

gameSetIdstring required

Query parameters

limitnumber

The approximate number of top players to return. The returned item count may include more to accommodate pagination with filters. Results may also be less if there are fewer than this many players.

cursorstring

The cursor to use for pagination.

withExternalIdboolean

Whether to include the externalId in the response

Response

Ranked list of top players with usernames

cursorstring

Example response

{
  "items": [
    {
      "userId": "0197381e-d0ef-700d-a3fc-f98501417877",
      "externalId": "reddit-0197381e-d0ef-700d-a3fc-f98501417877",
      "username": "bucking_bronco",
      "avatarUrl": "https://example.com/avatar.jpg",
      "gamesPlayedCount": 47,
      "correctAnswerCount": 42
    }
  ]
}