Get leaderboard ranking

GET

api/v1/user/{userKey}/leaderboards/{leaderboardId}/rankings

Retrieves the leaderboard rankings with pagination. Includes the current user's ranking if participated.

Request

Path Params

Query Params

Header Params

Responses

🟢200

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'api/v1/user/{{user-key}}/leaderboards/{{leaderboard_id}}/rankings?PageSize=10&PageNumber=1' \
--header 'x-api-key: {{api-key}}'

Response Example

{
    "rankings": [
        {
            "rank": 1,
            "userKey": "1765132434113",
            "highestScore": 44,
            "totalEntries": 2,
            "lastPlayedAt": "2025-12-19T15:35:05.374309Z"
        },
        {
            "rank": 2,
            "userKey": "1765133073489",
            "highestScore": 40,
            "totalEntries": 1,
            "lastPlayedAt": "2025-12-19T15:33:49.184454Z"
        },
        {
            "rank": 3,
            "userKey": "1765132435160",
            "highestScore": 21,
            "totalEntries": 1,
            "lastPlayedAt": "2025-12-19T15:34:02.819348Z"
        },
        {
            "rank": 4,
            "userKey": "1765132434656",
            "highestScore": 14,
            "totalEntries": 1,
            "lastPlayedAt": "2025-12-19T15:34:21.134244Z"
        },
        {
            "rank": 5,
            "userKey": "1765133171937",
            "highestScore": 10,
            "totalEntries": 1,
            "lastPlayedAt": "2025-12-19T14:14:31.479788Z"
        },
        {
            "rank": 6,
            "userKey": "1765133165304",
            "highestScore": 1,
            "totalEntries": 1,
            "lastPlayedAt": "2025-12-19T15:33:31.269572Z"
        }
    ],
    "totalParticipants": 6,
    "myRanking": {
        "rank": 1,
        "userKey": "1765132434113",
        "highestScore": 44,
        "totalEntries": 2,
        "lastPlayedAt": "2025-12-19T15:35:05.374309Z"
    },
    "leaderboardInfo": {
        "id": "a2235a1c-d5c1-4ad5-9b67-51ff6279ed03",
        "name": "Fancy one v2",
        "sortOrder": 0,
        "hasReward": true,
        "numberOfWinners": 5
    }
}

Modified at 2025-12-23 13:53:59

Get leaderboard details

Get user's record for a leaderboard