Game Loom
  1. Leaderboard
Game Loom
  • Game Loom
    • 👋 Welcome to Game Loom
  • Getting started
    • Introduction
    • 👤 Authentication
  • User Registration
    • Introduction
    • Single user registration
      POST
    • Bulk Register Users
      POST
  • Notifications
    • Overview
    • Receiving Event Notifications via Webhooks
    • Get All notifications for specific user
      GET
  • Rewards
    • Overview
    • Points
      • Record user point event
      • Get user points
      • Get Specific user point
    • Levels
      • Record user level event
      • Get user levels
      • Get Specific user level
    • Badges
      • Award badge to user
      • Get user badges
      • Get Specific user badge
  • Challenges (Gamification elements)
    • Introduction
    • Leaderboard
      • Get available leaderboards for user
        GET
      • Submit score to a leaderboard
        POST
      • Get user's leaderboard participation history
        GET
      • Get leaderboard details
        GET
      • Get leaderboard ranking
        GET
      • Get user's record for a leaderboard
        GET
      • Get user's entry history for a leaderboard
        GET
    • Survey
      • Overview
      • Get available surveys for user
      • Start a new survey participation
      • Get detailed user participation
      • Get user's survey participation history
      • Abandon survey participation
      • Save individual answer to survey question
      • Submit completed survey
      • Submit Survey with answers (One-Step Submission)
    • Open Challenge
      • Overview
      • Get available open challenges for user
      • Complete an open challenge
      • Get user's open challenge participation history
      • Get user open challenge by ID
    • Schemas
      • Survey Schame
  1. Leaderboard

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 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 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
Previous
Introduction
Next
Submit score to a leaderboard
Built with