---
title: "List leaderboard records."
method: GET
path: "/v2/console/leaderboard/{leaderboard_id}/records"
tags: ["Console"]
---

# List leaderboard records.

`GET /v2/console/leaderboard/{leaderboard_id}/records`

## Request

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

## Path parameters

- `leaderboard_id` string, required

## Query parameters

- `owner_ids` string[]
- `limit` integer
- `cursor` string
- `expiry` string, int64

## Response `200`

A successful response.

- LeaderboardRecordList: A set of leaderboard records, may be part of a leaderboard records page or a batch of individual records.
  - `records` LeaderboardRecord[]: A list of leaderboard records.
    - `leaderboard_id` string: The ID of the leaderboard this score belongs to.
    - `owner_id` string: The ID of the score owner, usually a user or group.
    - `username` string: The username of the score owner, if the owner is a user.
    - `score` string, int64: The score value.
    - `subscore` string, int64: An optional subscore value.
    - `num_score` integer: The number of submissions to this score record.
    - `metadata` string: Metadata.
    - `create_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was created.
    - `update_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was updated.
    - `expiry_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record expires.
    - `rank` string, int64: The rank of this record.
    - `max_num_score` integer: The maximum number of score updates allowed by the owner.
  - `owner_records` LeaderboardRecord[]: A batched set of leaderboard records belonging to specified owners.
    - `leaderboard_id` string: The ID of the leaderboard this score belongs to.
    - `owner_id` string: The ID of the score owner, usually a user or group.
    - `username` string: The username of the score owner, if the owner is a user.
    - `score` string, int64: The score value.
    - `subscore` string, int64: An optional subscore value.
    - `num_score` integer: The number of submissions to this score record.
    - `metadata` string: Metadata.
    - `create_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was created.
    - `update_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was updated.
    - `expiry_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record expires.
    - `rank` string, int64: The rank of this record.
    - `max_num_score` integer: The maximum number of score updates allowed by the owner.
  - `next_cursor` string: The cursor to send when retrieving the next page, if any.
  - `prev_cursor` string: The cursor to send when retrieving the previous page, if any.
  - `rank_count` string, int64: The total number of ranks available.

## 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)