Skip to main content
POST
Get Leaderboard

Authorizations

X-EntityToken
string
header
required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json

Request to load a leaderboard.

Request to load a leaderboard.

LeaderboardName
string
required

Name of the leaderboard.

PageSize
number
required

Maximum number of results to return from the leaderboard. Minimum 1, maximum 1,000.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

StartingPosition
number

Index position to start from. 1 is beginning of leaderboard.

Version
number

Optional version of the leaderboard, defaults to current version.

Response

Leaderboard response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object

Leaderboard response

Example:
Last modified on October 1, 2026