Authorizations
Headers
The language to return the achievements 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/achievements \
--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>"
}
},
"progressPeriod": "daily",
"displayMode": "default",
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"criteria": {
"type": "<string>",
"parameters": {
"query": "<any>",
"operator": "<any>",
"attribute": "<any>",
"value": "<any>"
}
},
"queries": [
{
"type": "<string>",
"alias": "<string>",
"parameters": {
"eventName": "<string>",
"eventCategory": "achievement",
"eventSubCategory": "achievement-completion",
"eventSourceId": "<string>",
"tags": [
"<string>"
]
},
"isCommunityScoped": true
}
],
"queryDescriptions": {},
"status": "archived",
"featured": true,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"startsAt": "<string>",
"expiresAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": "<string>",
"updatedBy": "<string>"
}
]
}
Retrieve a paginated list of achievements.
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/achievements \
--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>"
}
},
"progressPeriod": "daily",
"displayMode": "default",
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"criteria": {
"type": "<string>",
"parameters": {
"query": "<any>",
"operator": "<any>",
"attribute": "<any>",
"value": "<any>"
}
},
"queries": [
{
"type": "<string>",
"alias": "<string>",
"parameters": {
"eventName": "<string>",
"eventCategory": "achievement",
"eventSubCategory": "achievement-completion",
"eventSourceId": "<string>",
"tags": [
"<string>"
]
},
"isCommunityScoped": true
}
],
"queryDescriptions": {},
"status": "archived",
"featured": true,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"startsAt": "<string>",
"expiresAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": "<string>",
"updatedBy": "<string>"
}
]
}
The language to return the achievements in. If not provided, the default language for the organisation will be used.
1 <= x <= 100
x >= 0
Was this page helpful?