List leaderboards with pagination

Returns a paginated list of leaderboards belonging to the API-key's community.

Use this when a partner integration needs to render or sync the community's leaderboards (e.g. to power an external dashboard, widget catalog, or admin UI).

Authentication:

Bearer API key in Authorization header

API key must have the leaderboard permission

Community is resolved from the API key token — do not pass communityID

Returns 401 if the key is missing, invalid, or lacks the required permission

Rate limits:

Standard API rate limits apply

Constraints:

Pagination: page defaults to 1, limit defaults to 20, max 100

sort accepts field:asc or field:desc — field must be in the sortable whitelist (e.g. createdAt, updatedAt, name)

fields is a comma-separated projection — only whitelisted selectable fields are returned

search uses the keyword:<value> form and matches only searchable fields (e.g. name, slug)

Invalid sort/fields/search fields return 400

Example — list:

GET /leaderboards?page=1&limit=20&sort=createdAt:desc&fields=name,slug,enabled&search=keyword:top

Related endpoints:

GET /leaderboards/{leaderboardID} — read a single leaderboard

POST /leaderboards — create a leaderboard

PATCH /leaderboards/{leaderboardID} — update a leaderboard

DELETE /leaderboards/{leaderboardID} — delete a leaderboard

{ "meta": { "status": "success", "statusCode": 200, "page": 1, "limit": 20, "total": 2 }, "message": "Read leaderboards success.", "data": [ { "_id": "507f1f77bcf86cd799439012", "communityID": "507f1f77bcf86cd799439013", "name": "Top Traders", "slug": "top-traders", "description": "Monthly trading leaderboard", "rankBy": "currencies", "displayedFields": [ "name", "score" ], "displayFieldsOrder": [ "name", "score" ], "timeFilters": [ "all-time", "monthly" ], "duration": { "start": "2026-01-01T00:00:00.000Z", "end": "2026-12-31T23:59:59.999Z", "noEndDate": false, "timeZone": 7 }, "enabled": true, "previewEnabled": false, "selected": false, "createdAt": "2026-04-01T00:00:00.000Z", "updatedAt": "2026-04-13T12:00:00.000Z" } ] }

List leaderboards with pagination

Request

Responses