curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/templates/achievements \
--header 'x-api-token: <api-key>'{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<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": "<string>",
"operator": "==",
"attribute": "<string>",
"value": 123
}
},
"queries": [
{
"type": "<string>",
"alias": "<string>",
"parameters": {
"eventName": "<string>",
"eventCategory": "achievement",
"eventSubCategory": "achievement-completion",
"eventSourceId": "<string>",
"tags": [
"<string>"
]
},
"isCommunityScoped": true
}
],
"queryDescriptions": {},
"status": "archived",
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"rewardDistribution": {
"points": 1,
"xp": 1,
"rewardSelectionMethod": "all",
"distributionEventId": "<string>",
"rewardAllocations": [
{
"rewardId": "<string>",
"allocationId": "<string>",
"allocationType": "assets",
"amountToDistribute": 2
}
],
"numberOfRewardsToReceive": 1
},
"createdBy": "<string>",
"updatedBy": "<string>",
"communityId": "<string>",
"featured": true,
"startsAt": "<string>",
"expiresAt": "<string>"
}
]
}Get a paginated list of achievement templates available to your organisation.
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/templates/achievements \
--header 'x-api-token: <api-key>'{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<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": "<string>",
"operator": "==",
"attribute": "<string>",
"value": 123
}
},
"queries": [
{
"type": "<string>",
"alias": "<string>",
"parameters": {
"eventName": "<string>",
"eventCategory": "achievement",
"eventSubCategory": "achievement-completion",
"eventSourceId": "<string>",
"tags": [
"<string>"
]
},
"isCommunityScoped": true
}
],
"queryDescriptions": {},
"status": "archived",
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"rewardDistribution": {
"points": 1,
"xp": 1,
"rewardSelectionMethod": "all",
"distributionEventId": "<string>",
"rewardAllocations": [
{
"rewardId": "<string>",
"allocationId": "<string>",
"allocationType": "assets",
"amountToDistribute": 2
}
],
"numberOfRewardsToReceive": 1
},
"createdBy": "<string>",
"updatedBy": "<string>",
"communityId": "<string>",
"featured": true,
"startsAt": "<string>",
"expiresAt": "<string>"
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.nudj.cx/llms.txt
Use this file to discover all available pages before exploring further.
The language to return the achievements in. If not provided, the default language for the organisation will be used.
1 <= x <= 100x >= 0Was this page helpful?