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/integration/achievements \
--header 'x-api-token: <api-key>'
{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"details": {
"title": "<any>",
"description": "<any>",
"light": "<any>",
"dark": "<any>"
},
"progressPeriod": "daily",
"displayMode": "default",
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"criteria": {
"type": "sum",
"parameters": {
"query": "<any>",
"operator": "<any>",
"attribute": "<any>",
"value": "<any>"
}
},
"queries": [
{
"type": "event",
"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>",
"userState": {
"status": "completed",
"completedAt": "<string>",
"timesCompleted": 1,
"isClaimable": true,
"isClaimed": true,
"updatedAt": "<string>",
"earnedPoints": 1,
"earnedRewardAssets": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"rewardId": "<string>",
"allocationId": "<string>",
"userId": "<string>",
"details": {
"title": "<any>",
"description": "<any>",
"light": "<any>",
"dark": "<any>"
},
"redeemable": {
"instructions": "<any>",
"instructionsImageUrl": "<any>",
"supportEmail": "<any>",
"supportPhoneNumber": "<any>",
"supportUrl": "<any>",
"type": "<any>",
"additionalInformation": "<any>",
"redeemByDate": "<any>",
"content": "<any>"
},
"eventCategory": "achievement",
"eventSubCategory": "achievement-completion",
"eventSourceId": "<string>",
"tags": [
"<any>"
],
"campaigns": [
"<any>"
],
"metadata": {},
"claimedAt": "<string>",
"redeemedAt": "<string>",
"expiresAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"additionalCommunityIds": [
"<any>"
]
}
],
"earnedRewardEntries": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"rewardId": "<string>",
"userId": "<string>",
"rewardAssetIds": [
"<string>"
],
"details": {
"title": "<any>",
"description": "<any>",
"light": "<any>",
"dark": "<any>"
},
"totalEntries": 123,
"entries": [
{
"allocationId": "<string>",
"amount": 123,
"createdAt": "<string>"
}
],
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"checkByDate": "<string>",
"checkedAt": "<string>",
"drawnAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"additionalCommunityIds": [
"<string>"
],
"status": "pending",
"rewardAssets": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"rewardId": "<string>",
"allocationId": "<string>",
"userId": "<string>",
"details": {
"title": "<any>",
"description": "<any>",
"light": "<any>",
"dark": "<any>"
},
"redeemable": {
"instructions": "<any>",
"instructionsImageUrl": "<any>",
"supportEmail": "<any>",
"supportPhoneNumber": "<any>",
"supportUrl": "<any>",
"type": "<any>",
"additionalInformation": "<any>",
"redeemByDate": "<any>",
"content": "<any>"
},
"eventCategory": "achievement",
"eventSubCategory": "achievement-completion",
"eventSourceId": "<string>",
"tags": [
"<any>"
],
"campaigns": [
"<any>"
],
"metadata": {},
"claimedAt": "<string>",
"redeemedAt": "<string>",
"expiresAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"additionalCommunityIds": [
"<any>"
]
}
]
}
],
"earnedXp": 1,
"progressResetsAt": "<string>",
"type": "sum",
"isComplete": true,
"currentValue": 123,
"targetValue": 123,
"conditions": [
{}
]
},
"stats": {
"completedCount": 1
},
"reward": {
"points": 1,
"completionXp": 1,
"items": [
{
"id": "<string>",
"details": {
"title": "<any>",
"description": "<any>",
"light": "<any>",
"dark": "<any>"
},
"type": "assets",
"amountToDistribute": 1,
"totalSupply": 1,
"remainingSupply": 1
}
],
"rewardSelectionMethod": "all",
"numberOfRewardsToReceive": 1,
"distributionEventId": "<string>"
}
}
]
}
Retrieve a paginated list of achievements.
Supported query parameters:
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/integration/achievements \
--header 'x-api-token: <api-key>'
{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"details": {
"title": "<any>",
"description": "<any>",
"light": "<any>",
"dark": "<any>"
},
"progressPeriod": "daily",
"displayMode": "default",
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"criteria": {
"type": "sum",
"parameters": {
"query": "<any>",
"operator": "<any>",
"attribute": "<any>",
"value": "<any>"
}
},
"queries": [
{
"type": "event",
"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>",
"userState": {
"status": "completed",
"completedAt": "<string>",
"timesCompleted": 1,
"isClaimable": true,
"isClaimed": true,
"updatedAt": "<string>",
"earnedPoints": 1,
"earnedRewardAssets": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"rewardId": "<string>",
"allocationId": "<string>",
"userId": "<string>",
"details": {
"title": "<any>",
"description": "<any>",
"light": "<any>",
"dark": "<any>"
},
"redeemable": {
"instructions": "<any>",
"instructionsImageUrl": "<any>",
"supportEmail": "<any>",
"supportPhoneNumber": "<any>",
"supportUrl": "<any>",
"type": "<any>",
"additionalInformation": "<any>",
"redeemByDate": "<any>",
"content": "<any>"
},
"eventCategory": "achievement",
"eventSubCategory": "achievement-completion",
"eventSourceId": "<string>",
"tags": [
"<any>"
],
"campaigns": [
"<any>"
],
"metadata": {},
"claimedAt": "<string>",
"redeemedAt": "<string>",
"expiresAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"additionalCommunityIds": [
"<any>"
]
}
],
"earnedRewardEntries": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"rewardId": "<string>",
"userId": "<string>",
"rewardAssetIds": [
"<string>"
],
"details": {
"title": "<any>",
"description": "<any>",
"light": "<any>",
"dark": "<any>"
},
"totalEntries": 123,
"entries": [
{
"allocationId": "<string>",
"amount": 123,
"createdAt": "<string>"
}
],
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"checkByDate": "<string>",
"checkedAt": "<string>",
"drawnAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"additionalCommunityIds": [
"<string>"
],
"status": "pending",
"rewardAssets": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"rewardId": "<string>",
"allocationId": "<string>",
"userId": "<string>",
"details": {
"title": "<any>",
"description": "<any>",
"light": "<any>",
"dark": "<any>"
},
"redeemable": {
"instructions": "<any>",
"instructionsImageUrl": "<any>",
"supportEmail": "<any>",
"supportPhoneNumber": "<any>",
"supportUrl": "<any>",
"type": "<any>",
"additionalInformation": "<any>",
"redeemByDate": "<any>",
"content": "<any>"
},
"eventCategory": "achievement",
"eventSubCategory": "achievement-completion",
"eventSourceId": "<string>",
"tags": [
"<any>"
],
"campaigns": [
"<any>"
],
"metadata": {},
"claimedAt": "<string>",
"redeemedAt": "<string>",
"expiresAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"additionalCommunityIds": [
"<any>"
]
}
]
}
],
"earnedXp": 1,
"progressResetsAt": "<string>",
"type": "sum",
"isComplete": true,
"currentValue": 123,
"targetValue": 123,
"conditions": [
{}
]
},
"stats": {
"completedCount": 1
},
"reward": {
"points": 1,
"completionXp": 1,
"items": [
{
"id": "<string>",
"details": {
"title": "<any>",
"description": "<any>",
"light": "<any>",
"dark": "<any>"
},
"type": "assets",
"amountToDistribute": 1,
"totalSupply": 1,
"remainingSupply": 1
}
],
"rewardSelectionMethod": "all",
"numberOfRewardsToReceive": 1,
"distributionEventId": "<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?