Authorizations
Headers
The language to return the challenges in. If not provided, the default language for the organisation will be used.
Query Parameters
Required range:
1 <= x <= 100
Required range:
x >= 0
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/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>"
],
"challengeType": "survey",
"enabledForSingleView": true,
"actionGroups": [
{
"id": "<string>",
"parentGroupId": "<string>",
"type": "single",
"displayType": "list",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
}
}
],
"status": "archived",
"startDate": "<string>",
"endDate": "<string>",
"featured": true,
"threadId": "<string>",
"isSkippable": true,
"isLinear": true,
"unlockPrice": 1,
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"startsAt": "<string>",
"expiresAt": "<string>",
"groupIds": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"videoConfig": {
"videoUrl": "<string>",
"isVideoEnabled": true
}
}
]
}
Retrieve a paginated list of challenges.
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/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>"
],
"challengeType": "survey",
"enabledForSingleView": true,
"actionGroups": [
{
"id": "<string>",
"parentGroupId": "<string>",
"type": "single",
"displayType": "list",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
}
}
],
"status": "archived",
"startDate": "<string>",
"endDate": "<string>",
"featured": true,
"threadId": "<string>",
"isSkippable": true,
"isLinear": true,
"unlockPrice": 1,
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"startsAt": "<string>",
"expiresAt": "<string>",
"groupIds": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"videoConfig": {
"videoUrl": "<string>",
"isVideoEnabled": true
}
}
]
}
The language to return the challenges in. If not provided, the default language for the organisation will be used.
1 <= x <= 100
x >= 0
Was this page helpful?