---
title: "List leaderboards"
method: GET
path: "/v2/console/leaderboard"
tags: ["Console"]
---

# List leaderboards

`GET /v2/console/leaderboard`

## Request

- Base URL: `http://127.0.0.1:7351`
- URL: `http://127.0.0.1:7351/v2/console/leaderboard`
- Auth: API key in header `Authorization`

## Query parameters

- `cursor` string

## Response `200`

A successful response.

- ConsoleLeaderboardList: A list of leaderboards.
  - `leaderboards` ConsoleLeaderboard[]: The list of leaderboards returned.
    - `id` string: The ID of the leaderboard.
    - `title` string: The title for the leaderboard.
    - `description` string: The description of the leaderboard. May be blank.
    - `category` integer: The category of the leaderboard. e.g. "vip" could be category 1.
    - `sort_order` integer: ASC or DESC sort mode of scores in the leaderboard.
    - `size` integer: The current number of players in the leaderboard.
    - `max_size` integer: The maximum number of players for the leaderboard.
    - `max_num_score` integer: The maximum score updates allowed per player for the current leaderboard.
    - `operator` integer
    - `end_active` integer: The UNIX time when the leaderboard stops being active until next reset. A computed value.
    - `reset_schedule` string: Reset cron expression.
    - `metadata` string: Additional information stored as a JSON object.
    - `create_time` string, date-time: The UNIX time when the leaderboard was created.
    - `start_time` string, date-time: The UNIX time when the leaderboard will start.
    - `end_time` string, date-time: The UNIX time when the leaderboard will be stopped.
    - `duration` integer: Duration of the tournament in seconds.
    - `start_active` integer: The UNIX time when the leaderboard start being active. A computed value.
    - `join_required` boolean: Join required.
    - `authoritative` boolean: Authoritative.
    - `tournament` boolean: Tournament.
    - `prev_reset` integer: The UNIX time when the tournament was last reset. A computed value.
    - `next_reset` integer: The UNIX time when the tournament is next playable. A computed value.
  - `total` integer: Total count of leaderboards and tournaments.
  - `cursor` string: A cursor, if any.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2.md) - [All operations](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2/revisions/fbde2e3c5ead?raw)