AGaghanim
Leaderboards

Get Leaderboards

Changed on

Returns a list of leaderboards.

get/v1/leaderboards

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/leaderboards
  • Auth
    HTTP bearer

Query parameters

limitinteger

A limit on the number of objects to be returned

offsetinteger

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.

Changes

  • 0ef278347679Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • fb9750c99d0aRevision changes
    • warning

      for the query request parameter limit, the exclusiveMinimum was set to 1.00

    • warning

      for the query request parameter limit, the max was set to 300.00

    • warning

      for the query request parameter offset, the min was set to 0.00