Leaderboards

Get app global leaderboards

get

Get leaderboards for all mini game types and default games for the authenticated app. Optionally filter by a specific mini game type ID. For games without a mini game type, the miniGameTypeName is not present.

Authorizations

AppAPIKey

x-app-api-keystringRequired

App API key in format:

Query parameters

miniGameTypeIdstringOptional

Optional mini game type ID to filter leaderboards for a specific game type. If not provided, leaderboards for all game types will be returned.

limitinteger · min: 1Optional

Maximum number of players to return per leaderboard. Defaults to 10 if not specified.

Default: 10

Responses

200

Leaderboards retrieved successfully

application/json

401

Unauthorized - invalid or missing API key

application/json

404

App not found

application/json

500

Internal server error

application/json

get

/apps/global-leaderboards

HTTPcURLJavaScriptPython

GET /api/v1/apps/global-leaderboards HTTP/1.1
Host: 
x-app-api-key: YOUR_API_KEY
Accept: */*

{
  "leaderboards": [
    {
      "miniGameTypeId": "text",
      "miniGameTypeName": "text",
      "leaderboard": [
        {
          "playerId": "text",
          "playerDisplayName": "text",
          "playerScore": 1,
          "playerImageUrl": "text",
          "createdAt": "2025-12-25T03:25:18.149Z",
          "updatedAt": "2025-12-25T03:25:18.149Z",
          "gameSessionId": "text",
          "userId": "text",
          "username": "text"
        }
      ]
    }
  ]
}