curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/challenge-groups \
--header 'x-api-token: <api-key>'{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"type": "random",
"period": "daily",
"challengeIds": [
"<string>"
],
"activeAmount": 2,
"status": "archived",
"createdAt": "<string>",
"updatedAt": "<string>"
}
]
}Retrieve a paginated list of challenge groups.
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/challenge-groups \
--header 'x-api-token: <api-key>'{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"type": "random",
"period": "daily",
"challengeIds": [
"<string>"
],
"activeAmount": 2,
"status": "archived",
"createdAt": "<string>",
"updatedAt": "<string>"
}
]
}The language to return the challenge groups in. If not provided, the default language for the organisation will be used.
1 <= x <= 100x >= 0Successful response
Show child attributes
The id of the challenge group
The id of the organisation the challenge group belongs to
The id of the community the challenge group belongs to
Used to describe an entity
Show child attributes
The title of the entity
The description of the entity
The challenge selection type
random, sequential The rotation period
daily, weekly, monthly, yearly, open The challenge IDs in this group
Number of active challenges to show
x >= 1The challenge group status
archived, draft, expired, live, scheduled The creation date of the challenge group
The update date of the challenge group
Was this page helpful?