Skip to main content

Get users

GET 
/leaderboards/:leaderboard_slug/users

Paginated user list with ranked or assigned source. Requires x-client-id, x-client-secret, and Authorization bearer token. Caller must have client.leaderboard permission.

Request​

Responses​

Successful Response

Query parameters​

  • league (optional, string): league slug filter
  • limit, offset: pagination
  • source (optional, default ranked): ranked or assigned (AT_RESET boards only for assigned)
  • expand (optional): set to profile to attach profile snippets

source=assigned returns 400 on non-AT_RESET boards. Users without a stat may have rank: null and stat_value: null.

Response example (200 OK)​

{
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 37,
    "has_more": false
  },
  "league": "silver",
  "users": [
    {
      "rank": 1,
      "user_id": 10,
      "stat_value": 1500.0,
      "league": "silver",
      "profile": {
        "nickname": "Ace",
        "avatar_url": null
      }
    }
  ]
}

cURL example (assigned cohort with profile)​

curl -X GET "http://localhost:8000/client/leaderboards/daily-elo/users?source=assigned&league=silver&expand=profile" \
  -H "x-client-id: <your-client-id>" \
  -H "x-client-secret: <your-client-secret>" \
  -H "Authorization: Bearer <access-token>"