Skip to main content
GET
/
leaderboards
/
configs
Get paginated leaderboard configurations
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/admin/leaderboards/configs \
  --header 'x-api-token: <api-key>'
{
  "totalCount": 123,
  "edges": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "name": "<string>",
      "startsAt": "<string>",
      "conditions": [
        {
          "type": "<string>",
          "communityId": "<string>"
        }
      ],
      "rewardsConfig": [
        {
          "startRank": 2,
          "endRank": 2,
          "distributionEventId": "<string>"
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "description": "<string>",
      "expiresAt": "<string>"
    }
  ]
}

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
​
search
string
​
communityId
string

Response

Successful response

​
totalCount
number
required
​
edges
LeaderboardConfigAdmin · object[]
required