Leaderboard Details

The "Leaderboard Details" method provides in-depth information for a specific leaderboard, including player rankings and scores. It is ideal for displaying personalized or focused leaderboard information.

Endpoint

GET /v1/admin/leaderboards/{leaderboardID}

Path Parameters

Parameter	Type	Required	Description
leaderboardID	string	Yes	Unique identifier for the leaderboard

Response

{
"code": 200,
"data": [
  {
    "uid": "72a6a761347f48b6b5162ebab7fc9ac9",
    "label": "Caffeine Overloaders",
    "description": "Collect points via orders containing any kind of coffee",
    "startDate": "2024-03-13T00:00:00",
    "endDate": "2030-12-31T23:55:00",
    "imageName": "https://rapidmulestorage.blob.core.windows.net/images/93779f56-26cf-4ac1-8103-26abc3fd2f0c_cup_14036518.png",
    "randomizedPrize": true,
    "limited": true,
    "isActive": true,
    "type": 0,
    "standings": [
      {
        "rank": 1,
        "points": 96,
        "userId": "m1k1463A2DfjjE9zN57hZDagiyx1",
        "username": "Player1",
        "imageName": null
      },
      {
        "rank": 2,
        "points": 84,

Request Example

curl -X GET https://api.rapidmule.com/v1/admin/leaderboards/{{leaderboardID}} \
  -H "Authorization: Bearer YOUR_API_KEY"

Use Cases

• Full Standings Display: Show complete player rankings with scores
• Player Rank Lookup: Find specific player's current position
• Widget Integration: Build leaderboard UI widgets for your application

Error Codes

Code	Description	Resolution
1001	Payload is null	Check path parameters
4001	Invalid AuthKey	Verify API key
9007	Leaderboard does not exist	Use valid leaderboardId

Related Endpoints

• Leaderboards - Get all leaderboards