Get available leaderboards for user

GET

api/v1/user/{userKey}/leaderboards

Retrieves all leaderboards available for the user to participate in, filtered by targeting criteria.

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?PageNumber=1&PageSize=10' \
--header 'x-api-key: {{api-key}}'

Response Example

{
    "data": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "startDate": "string",
            "endDate": "string",
            "hasReward": true,
            "numberOfWinners": 0,
            "sortOrder": 0,
            "localizedName": null,
            "localizedDescription": null,
            "myRecord": {
                "id": "string",
                "leaderboardId": "string",
                "highestScore": 0,
                "lowestScore": 0,
                "totalEntries": 0,
                "currentRank": null,
                "lastPlayedAt": "string",
                "firstPlayedAt": "string"
            }
        }
    ],
    "pageNumber": 0,
    "pageSize": 0,
    "totalCount": 0,
    "totalPages": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
}

Modified at 2025-12-23 13:27:19

Introduction

Submit score to a leaderboard