Sign in

v

latestOpenAPI 3.1.02026-08-09171439927.8 KB
Leaderboards

Get Leaderboards

Returns a list of leaderboards.

get/v1/leaderboards

Query parameters

limitinteger

A limit on the number of objects to be returned

A limit on the number of objects to be returned

offsetinteger

The number of objects to skip

The number of objects to skip

Response

Successful Response

namestring required

The name of the leaderboard.

descriptionstring required

The description of the leaderboard.

visibility'general' | 'personal'
start_atinteger

The start date of the leaderboard in Unix timestamp.If set, the leaderboard will only be visible in game-hub after this date.

end_atinteger

The end date of the leaderboard in Unix timestamp.If set, the leaderboard will only be visible in game-hub before this date.

idstring required

The unique identifier of the leaderboard.