Sign in
latestOpenAPI 3.0.02026-08-10239286205.0 KB

e86f45ae5f7c

gameset-plays

List the top players for a game set; with their emails

Ranked by the most games played for that GameSet. Only returns users with emails. Requires ADMIN role, to protect PII.

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

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

List of top players with metadata

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,
      "email": "sarah@example.com",
      "emailVerified": true
    }
  ]
}