Achievements
Action Participations
Actions
Auth Config
Challenge Groups
Challenges
Communities
Feature Flags
Game
Leaderboards
- GETGet aggregated leaderboard data
- GETGet paginated leaderboard configurations
- Get leaderboards configs leaderboardConfigId
- GETGet distribution details for a leaderboard config
- PATCHUpdate a leaderboard configuration
- POSTCreate a new leaderboard configuration
- POSTCreate default leaderboard configs
- POSTAssign distribution details to a leaderboard config
Legal Policies
Rewards
- GETGet paginated rewards
- GETGet reward by ID
- GETGet paginated reward entries for a specific reward
- GETGet paginated reward redemption values for a specific reward
- POSTCreate a reward
- POSTUpdate a reward by id
- POSTProcess manual reward distribution
- POSTProcess manual reward giveaway
- POSTProcess reward redemption values from CSV
Tags
Teams
Templates
Third Party Config
Users
Variables
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/templates/challenges \
--header 'x-api-token: <api-key>'{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"additionalCommunityIds": [
"<string>"
],
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"progressPeriod": "daily",
"maxCompletionsPerPeriod": 1,
"numberOfActions": 1,
"actionIds": [
"<string>"
],
"actionGroups": [
{
"id": "<string>",
"type": "single",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"parentGroupId": "<string>",
"displayType": "list"
}
],
"status": "archived",
"isLinear": true,
"unlockPrice": 1,
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"groupIds": [
"<string>"
],
"createdAt": "<string>",
"videoConfig": {
"videoUrl": "<string>",
"isVideoEnabled": true
},
"challengeType": "survey",
"enabledForSingleView": true,
"startDate": "<string>",
"endDate": "<string>",
"featured": true,
"threadId": "<string>",
"isSkippable": true,
"startsAt": "<string>",
"expiresAt": "<string>",
"updatedAt": "<string>"
}
]
}Get paginated challenge templates
Get a paginated list of challenge templates available to your organisation.
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/templates/challenges \
--header 'x-api-token: <api-key>'{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"additionalCommunityIds": [
"<string>"
],
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"progressPeriod": "daily",
"maxCompletionsPerPeriod": 1,
"numberOfActions": 1,
"actionIds": [
"<string>"
],
"actionGroups": [
{
"id": "<string>",
"type": "single",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"parentGroupId": "<string>",
"displayType": "list"
}
],
"status": "archived",
"isLinear": true,
"unlockPrice": 1,
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"groupIds": [
"<string>"
],
"createdAt": "<string>",
"videoConfig": {
"videoUrl": "<string>",
"isVideoEnabled": true
},
"challengeType": "survey",
"enabledForSingleView": true,
"startDate": "<string>",
"endDate": "<string>",
"featured": true,
"threadId": "<string>",
"isSkippable": true,
"startsAt": "<string>",
"expiresAt": "<string>",
"updatedAt": "<string>"
}
]
}Authorizations
Headers
The language to return the challenges in. If not provided, the default language for the organisation will be used.
Query Parameters
1 <= x <= 100x >= 0Response
Successful response
Show child attributes
Show child attributes
The id of the challenge
The id of the organisation the challenge belongs to
The id of the community the challenge belongs to
The ids of any additional communities the challenge belongs to
Used to describe an entity
Show child attributes
Show child attributes
The title of the entity
The description of the entity
The progress period of the challenge
daily, weekly, monthly, yearly, open The maximum number of completions per period for the challenge
x >= 0The number of actions in the challenge
x >= 0The ids of the actions in the challenge
The action groups of the challenge
Show child attributes
Show child attributes
single, group, child Used to describe an entity
Show child attributes
Show child attributes
The title of the entity
The description of the entity
list, grid, stepper, map, chapters, widget The status of the challenge
archived, draft, expired, live, scheduled Whether the challenge must be completed in sequential order
The number of keys required to unlock this challenge
x >= 0The tags of the challenge
The campaigns of the challenge
The organisations that the challenge is available as a template for
Whether the challenge is a global template
The challenge groups the challenge belongs to
The creation date of the challenge
The type of the challenge
survey Whether the challenge is enabled for single view
Deprecated use startsAt instead
Deprecated use expiresAt instead
The thread id of the challenge
Whether the challenge is skippable
The start date of the challenge
The expiry date of the challenge
The update date of the challenge
Was this page helpful?