Skip to main content

List leaderboards

GET 
/leaderboards

List all leaderboards for the current project. Requires x-client-id, x-client-secret, and Authorization bearer token. Caller must have client.leaderboard permission.

Request​

Responses​

Successful Response

Query parameters​

  • include (optional): comma-separated meta, leagues, rewards — expands each list item inline

Response example (200 OK)​

{
  "leaderboards": [
    {
      "slug": "daily-elo",
      "name": "Daily ELO",
      "leaderboard_type": "relative",
      "leagues_enabled": true,
      "expired": false,
      "meta": null,
      "leagues": null,
      "rewards": null
    }
  ]
}

When include=meta,leagues,rewards is set, the optional fields on each summary are populated.

cURL example​

curl -X GET "http://localhost:8000/client/leaderboards?include=meta,leagues" \
  -H "x-client-id: <your-client-id>" \
  -H "x-client-secret: <your-client-secret>" \
  -H "Authorization: Bearer <access-token>"