Skip to main content
GET
/
leaderboards
/
configs
Get paginated leaderboard configurations
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/leaderboards/configs \
  --header 'x-api-token: <api-key>'
{
  "totalCount": 123,
  "edges": [
    {
      "name": "<string>",
      "description": "<string>",
      "metricType": "total-xp",
      "startsAt": "<string>",
      "expiresAt": "<string>",
      "status": "archived",
      "period": "daily",
      "conditions": [],
      "id": "<string>",
      "organisationId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "reward": [
        {
          "startRank": 123,
          "endRank": 123,
          "points": 1,
          "completionXp": 1,
          "items": [
            {
              "id": "<string>",
              "organisationId": "<string>",
              "communityId": "<string>",
              "additionalCommunityIds": [
                "<string>"
              ],
              "details": {
                "title": "<string>",
                "description": "<string>",
                "light": {},
                "dark": {}
              },
              "assetPointsPrice": 1,
              "assetPointsSwapValue": 1,
              "entryPointsPrice": 1,
              "assetsSupply": 1,
              "entriesSupply": 1,
              "maxAssetsPerUser": 2,
              "maxEntriesPerUser": 2,
              "allocationsType": "assets-only",
              "isSharedAssetsSupply": true,
              "isSharedEntriesSupply": true,
              "allocations": [
                {
                  "id": "<string>",
                  "allocationType": "assets",
                  "supply": 1,
                  "amountToDistribute": 2,
                  "distributed": 1,
                  "isShop": true,
                  "isLive": true
                }
              ],
              "redemptionConfig": {
                "instructions": "<string>",
                "instructionsImageUrl": "<string>",
                "supportEmail": "jsmith@example.com",
                "supportPhoneNumber": "<string>",
                "supportUrl": "<string>",
                "type": "rich-text",
                "additionalInformation": [
                  {
                    "variableConfigId": "<any>",
                    "required": "<any>",
                    "position": "<any>"
                  }
                ],
                "redeemByDate": "<string>",
                "autoRedeem": false,
                "content": "<string>"
              },
              "featured": true,
              "tags": [
                {
                  "id": "<any>",
                  "organisationId": "<any>",
                  "value": "<any>",
                  "config": "<any>",
                  "createdAt": "<any>",
                  "updatedAt": "<any>"
                }
              ],
              "campaigns": [
                {
                  "id": "<any>",
                  "organisationId": "<any>",
                  "name": "<any>",
                  "startDate": "<any>",
                  "endDate": "<any>",
                  "status": "<any>",
                  "createdAt": "<any>",
                  "updatedAt": "<any>"
                }
              ],
              "status": "archived",
              "drawsAt": "<string>",
              "startsAt": "<string>",
              "expiresAt": "<string>",
              "isManualGiveaway": true,
              "availableAsTemplateForOrganisations": [
                "<string>"
              ],
              "isGlobalTemplate": true,
              "metadata": {},
              "createdAt": "<string>",
              "updatedAt": "<string>",
              "challenges": [
                {
                  "id": "<string>",
                  "organisationId": "<string>",
                  "communityId": "<string>",
                  "additionalCommunityIds": [
                    "<string>"
                  ],
                  "details": {
                    "title": "<string>",
                    "description": "<string>",
                    "light": {},
                    "dark": {}
                  },
                  "progressPeriod": "daily",
                  "maxCompletionsPerPeriod": 1,
                  "numberOfActions": 1,
                  "actionIds": [
                    "<string>"
                  ],
                  "challengeType": "survey",
                  "enabledForSingleView": true,
                  "actionGroups": [
                    {
                      "id": "<any>",
                      "parentGroupId": "<any>",
                      "type": "<any>",
                      "displayType": "<any>",
                      "details": "<any>"
                    }
                  ],
                  "status": "archived",
                  "startDate": "<string>",
                  "endDate": "<string>",
                  "featured": true,
                  "threadId": "<string>",
                  "isSkippable": true,
                  "isLinear": true,
                  "unlockPrice": 1,
                  "tags": [
                    {
                      "id": "<any>",
                      "organisationId": "<any>",
                      "value": "<any>",
                      "config": "<any>",
                      "createdAt": "<any>",
                      "updatedAt": "<any>"
                    }
                  ],
                  "campaigns": [
                    {
                      "id": "<any>",
                      "organisationId": "<any>",
                      "name": "<any>",
                      "startDate": "<any>",
                      "endDate": "<any>",
                      "status": "<any>",
                      "createdAt": "<any>",
                      "updatedAt": "<any>"
                    }
                  ],
                  "availableAsTemplateForOrganisations": [
                    "<string>"
                  ],
                  "isGlobalTemplate": true,
                  "startsAt": "<string>",
                  "expiresAt": "<string>",
                  "groupIds": [
                    "<string>"
                  ],
                  "createdAt": "<string>",
                  "updatedAt": "<string>",
                  "videoConfig": {
                    "videoUrl": "<string>",
                    "isVideoEnabled": true
                  },
                  "actions": [
                    {
                      "id": "<any>",
                      "organisationId": "<any>",
                      "communityId": "<any>",
                      "allocationId": "<any>",
                      "allocatedTo": "<any>",
                      "actionGroupId": "<any>",
                      "actionGroupIndex": "<any>",
                      "position": "<any>",
                      "category": "<any>",
                      "key": "<any>",
                      "details": "<any>",
                      "progressPeriod": "<any>",
                      "maxCompletionsPerPeriod": "<any>",
                      "attributes": "<any>",
                      "config": "<any>",
                      "videoMetadata": "<any>",
                      "createdAt": "<any>",
                      "availableAsTemplateForOrganisations": "<any>",
                      "isGlobalTemplate": "<any>",
                      "previousAction": "<any>",
                      "nextAction": "<any>",
                      "stats": "<any>",
                      "reward": "<any>",
                      "userState": "<any>",
                      "participations": "<any>"
                    }
                  ],
                  "community": {
                    "id": "<string>",
                    "name": "<string>",
                    "description": "<string>",
                    "slug": "<string>",
                    "logo": "<string>"
                  },
                  "participantStats": {
                    "startedCount": 1,
                    "completedCount": 1
                  },
                  "stats": {
                    "totalXp": 1,
                    "totalActionsCount": 1
                  },
                  "reward": {
                    "points": 1,
                    "completionXp": 1,
                    "items": [
                      "<any>"
                    ],
                    "rewardSelectionMethod": "all",
                    "numberOfRewardsToReceive": 1,
                    "distributionEventId": "<string>"
                  },
                  "userState": {
                    "status": "completed",
                    "completionsInPeriod": 0,
                    "totalCompletions": 0,
                    "keysContributed": 0,
                    "latestAttempt": {
                      "eligibleXp": "<any>",
                      "actionsCompletedCount": "<any>",
                      "startedAt": "<any>",
                      "earnedXp": "<any>",
                      "earnedPoints": "<any>",
                      "earnedRewardAssets": "<any>",
                      "earnedRewardEntries": "<any>",
                      "completionTime": "<any>",
                      "successRate": "<any>"
                    },
                    "historicAttempts": []
                  }
                }
              ],
              "achievements": [
                {
                  "id": "<string>",
                  "organisationId": "<string>",
                  "communityId": "<string>",
                  "details": {
                    "title": "<string>",
                    "description": "<string>",
                    "light": {},
                    "dark": {}
                  },
                  "progressPeriod": "daily",
                  "displayMode": "default",
                  "tags": [
                    "<string>"
                  ],
                  "campaigns": [
                    "<string>"
                  ],
                  "criteria": {
                    "type": "sum",
                    "parameters": {}
                  },
                  "queries": [
                    {
                      "type": "<any>",
                      "alias": "<any>",
                      "parameters": "<any>",
                      "isCommunityScoped": "<any>"
                    }
                  ],
                  "queryDescriptions": {},
                  "status": "archived",
                  "featured": true,
                  "availableAsTemplateForOrganisations": [
                    "<string>"
                  ],
                  "isGlobalTemplate": true,
                  "startsAt": "<string>",
                  "expiresAt": "<string>",
                  "createdAt": "<string>",
                  "updatedAt": "<string>",
                  "userState": {
                    "status": "completed",
                    "completedAt": "<string>",
                    "timesCompleted": 1,
                    "isClaimable": true,
                    "isClaimed": true,
                    "updatedAt": "<string>",
                    "earnedPoints": 1,
                    "earnedRewardAssets": [
                      "<any>"
                    ],
                    "earnedRewardEntries": [
                      "<any>"
                    ],
                    "earnedXp": 1,
                    "progressResetsAt": "<string>",
                    "type": "sum",
                    "isComplete": true,
                    "currentValue": 123,
                    "targetValue": 123,
                    "conditions": [
                      "<any>"
                    ]
                  },
                  "stats": {
                    "completedCount": 1
                  },
                  "reward": {
                    "points": 1,
                    "completionXp": 1,
                    "items": [
                      "<any>"
                    ],
                    "rewardSelectionMethod": "all",
                    "numberOfRewardsToReceive": 1,
                    "distributionEventId": "<string>"
                  }
                }
              ],
              "initialAssetSupply": 1,
              "initialEntrySupply": 1,
              "distributedAssetCount": 1,
              "distributedEntryCount": 1,
              "remainingAssetSupply": 1,
              "remainingEntrySupply": 1,
              "remainingShopAssetSupply": 1,
              "remainingShopEntrySupply": 1,
              "userEntryCount": 0,
              "userAssetCount": 0
            }
          ],
          "rewardSelectionMethod": "all",
          "numberOfRewardsToReceive": 1
        }
      ]
    }
  ]
}

Authorizations

x-api-token
string
header
required

Headers

x-language
string

The language to return the leaderboards in. If not provided, the default language for the organisation will be used.

Query Parameters

limit
integer
default:10
Required range: 1 <= x <= 100
skip
integer
default:0
Required range: x >= 0
status
enum<string>
Available options:
archived,
draft,
expired,
live,
scheduled
communityId
string

Response

Successful response

totalCount
number
required
edges
object[]
required
I