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>",
"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": "sum",
"parameters": {
"query": "<string>",
"operator": "==",
"attribute": "<string>",
"value": 123
}
},
"queries": [
{
"type": "event",
"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>",
"userState": {
"status": "completed",
"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": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"redeemable": {
"type": "rich-text",
"additionalInformation": [
{
"variableConfigId": "<string>",
"required": true,
"position": 2
}
],
"content": "<string>",
"instructions": "<string>",
"instructionsImageUrl": "<string>",
"supportEmail": "[email protected]",
"supportPhoneNumber": "<string>",
"supportUrl": "<string>",
"redeemByDate": "<string>"
},
"eventCategory": "achievement",
"eventSubCategory": "achievement-completion",
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"additionalCommunityIds": [
"<string>"
],
"eventSourceId": "<string>",
"claimedAt": "<string>",
"redeemedAt": "<string>",
"expiresAt": "<string>"
}
],
"earnedRewardEntries": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"rewardId": "<string>",
"userId": "<string>",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"totalEntries": 123,
"entries": [
{
"allocationId": "<string>",
"amount": 123,
"createdAt": "<string>"
}
],
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"additionalCommunityIds": [
"<string>"
],
"status": "pending",
"rewardAssetIds": [
"<string>"
],
"checkByDate": "<string>",
"checkedAt": "<string>",
"drawnAt": "<string>",
"rewardAssets": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"rewardId": "<string>",
"allocationId": "<string>",
"userId": "<string>",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"redeemable": {
"type": "rich-text",
"additionalInformation": [
{
"variableConfigId": "<string>",
"required": true,
"position": 2
}
],
"content": "<string>",
"instructions": "<string>",
"instructionsImageUrl": "<string>",
"supportEmail": "[email protected]",
"supportPhoneNumber": "<string>",
"supportUrl": "<string>",
"redeemByDate": "<string>"
},
"eventCategory": "achievement",
"eventSubCategory": "achievement-completion",
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"additionalCommunityIds": [
"<string>"
],
"eventSourceId": "<string>",
"claimedAt": "<string>",
"redeemedAt": "<string>",
"expiresAt": "<string>"
}
]
}
],
"earnedXp": 1,
"type": "sum",
"isComplete": true,
"currentValue": 123,
"targetValue": 123,
"conditions": "<array>",
"completedAt": "<string>",
"progressResetsAt": "<string>"
},
"stats": {
"completedCount": 1
},
"reward": {
"points": 1,
"completionXp": 1,
"items": [
{
"id": "<string>",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"type": "assets",
"amountToDistribute": 1,
"totalSupply": 1,
"remainingSupply": 1
}
],
"rewardSelectionMethod": "all",
"numberOfRewardsToReceive": 1,
"distributionEventId": "<string>"
},
"communityId": "<string>",
"featured": true,
"startsAt": "<string>",
"expiresAt": "<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>",
"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": "sum",
"parameters": {
"query": "<string>",
"operator": "==",
"attribute": "<string>",
"value": 123
}
},
"queries": [
{
"type": "event",
"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>",
"userState": {
"status": "completed",
"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": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"redeemable": {
"type": "rich-text",
"additionalInformation": [
{
"variableConfigId": "<string>",
"required": true,
"position": 2
}
],
"content": "<string>",
"instructions": "<string>",
"instructionsImageUrl": "<string>",
"supportEmail": "[email protected]",
"supportPhoneNumber": "<string>",
"supportUrl": "<string>",
"redeemByDate": "<string>"
},
"eventCategory": "achievement",
"eventSubCategory": "achievement-completion",
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"additionalCommunityIds": [
"<string>"
],
"eventSourceId": "<string>",
"claimedAt": "<string>",
"redeemedAt": "<string>",
"expiresAt": "<string>"
}
],
"earnedRewardEntries": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"rewardId": "<string>",
"userId": "<string>",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"totalEntries": 123,
"entries": [
{
"allocationId": "<string>",
"amount": 123,
"createdAt": "<string>"
}
],
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"additionalCommunityIds": [
"<string>"
],
"status": "pending",
"rewardAssetIds": [
"<string>"
],
"checkByDate": "<string>",
"checkedAt": "<string>",
"drawnAt": "<string>",
"rewardAssets": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"rewardId": "<string>",
"allocationId": "<string>",
"userId": "<string>",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"redeemable": {
"type": "rich-text",
"additionalInformation": [
{
"variableConfigId": "<string>",
"required": true,
"position": 2
}
],
"content": "<string>",
"instructions": "<string>",
"instructionsImageUrl": "<string>",
"supportEmail": "[email protected]",
"supportPhoneNumber": "<string>",
"supportUrl": "<string>",
"redeemByDate": "<string>"
},
"eventCategory": "achievement",
"eventSubCategory": "achievement-completion",
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"additionalCommunityIds": [
"<string>"
],
"eventSourceId": "<string>",
"claimedAt": "<string>",
"redeemedAt": "<string>",
"expiresAt": "<string>"
}
]
}
],
"earnedXp": 1,
"type": "sum",
"isComplete": true,
"currentValue": 123,
"targetValue": 123,
"conditions": "<array>",
"completedAt": "<string>",
"progressResetsAt": "<string>"
},
"stats": {
"completedCount": 1
},
"reward": {
"points": 1,
"completionXp": 1,
"items": [
{
"id": "<string>",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"type": "assets",
"amountToDistribute": 1,
"totalSupply": 1,
"remainingSupply": 1
}
],
"rewardSelectionMethod": "all",
"numberOfRewardsToReceive": 1,
"distributionEventId": "<string>"
},
"communityId": "<string>",
"featured": true,
"startsAt": "<string>",
"expiresAt": "<string>"
}
]
}The language to return the achievements 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 achievement
The id of the organisation this achievement belongs to
Used to describe an entity
Show child attributes
The title of the entity
The description of the entity
The period over which progress is tracked/reset
daily, weekly, monthly, yearly, open The display mode for the achievement. Useful to make the distinction between normal user achievments and achievments designed for implementing custom app functionality.
default, custom The ids of the tags on the achievement
The ids of the campaigns on the achievement
This represents a condition that must be met by a user for the achievement to be completed
Show child attributes
Identifies this node as a SumNode type, which is responsible for summing numeric attributes from events and comparing against a threshold
sum Parameters for a sum condition node that define the attribute summation logic and threshold comparison
Show child attributes
Reference to the query alias that identifies which events should be included in the sum. This query must be defined in an EventQueryNode within the achievement's criteria array.
Comparison operator that defines how to compare the summed value against the threshold value. For example, 'GreaterThan' would check if the sum exceeds the threshold.
==, !=, >, <, >=, <= The specific event attribute whose values should be summed. This must be a numeric attribute present in the matched events.
1The threshold value to compare the sum against. This represents the target number that the summed values will be compared to using the specified operator.
The event queries used to measure progress against this achievement's criteria
Show child attributes
Identifies this node as an EventQueryNode type, which defines criteria for selecting events to be evaluated
event A unique identifier for this query that can be referenced by condition nodes. This allows the same event query to be reused across multiple conditions.
Parameters that define the criteria for matching and filtering events
Show child attributes
The specific name of the event to match. This identifies the type of event that should be included in the achievement progress. When using a custom event, this should be the name of the event. When using a non-custom event, this should be the name of the event category and sub-category concatenated with an underscore.
The category of events to match. This helps filter events by their broad classification within the system.
achievement, action, auth, blog, challenge, community, custom, game, leaderboard, organisation, points, post, referral, reward, shop, social, social-connection, streak, user, variable, xp The sub-category of events to match. This provides more granular filtering within the selected event category.
achievement-completion, facebook-comment, facebook-follow, facebook-like, image-analysis-object-detection, image-analysis-receipt-detection, instagram-follow, instagram-like, instagram-comment, instagram-share, instagram-post, interaction-engage-with-content, interaction-external-link, interaction-image-upload, interaction-spot-object, platform-comment-on-post, platform-complete-achievement, platform-generative-action, platform-like-post, platform-play-game, platform-validate-event, question-multiple-choice, question-open-ended, question-rate-your-experience, question-secret-access-code, question-select-date, question-select-from-images, question-select-value-in-range, question-select-from-list, question-closed-ended, question-vote, spotify-follow, spotify-listen, spotify-save, tiktok-follow, tiktok-watch, tiktok-post, youtube-like, youtube-comment, youtube-subscribe, action-completion, skip-action, 42-school, api-auth-link, api-token-link, apple, asgardeo, atlassian, auth0, authentik, azure-ad-b2c, azure-ad, azure-devops, battlenet, beyondidentity, box, boxyhq-saml, bungie, click-up, cognito, coinbase, descope, discord, dribbble, dropbox, duende-identity-server6, email, eveonline, facebook, faceit, foursquare, freshbooks, fusionauth, github, gitlab, google, hubspot, identity-server4, instagram, kakao, keycloak, line, linkedin, mailchimp, mailru, mastodon, mattermost, medium, naver, netlify, notion, okta, onelogin, organisation-oidc, osso, osu, passage, patreon, pinterest, pipedrive, reddit, salesforce, slack, spotify, strava, tiktok, todoist, trakt, twitch, twitter, united-effects, vk, wikimedia, wordpress, workos, yandex, youtube, zitadel, zoho, zoom, blog-comment, blog-like, blog-share, blog-view, challenge-started, challenge-completion, challenge-unlock, community-visit, parental-approval-requested, parental-approval-approved, parental-approval-rejected, custom, game-started, game-completed, leaderboard-finish, invite-admin-user, points-credit, points-spend, post-comment, post-like, post-view, reward-redemption, reward-allocation-purchase, reward-giveaway-winner, reward-claim, reward-distribution, manual-distribution, referral-link-used, shop-purchase, share-challenge-details, share-challenge-results, share-community, share-reward, share-post, share-profile, share-anything, streak-extended, profile-picture-added, bio-added, variable-captured, xp-gained, xp-total, xp-leaderboard-topper Optional identifier for the source of the events. When specified, only events from this source will count towards the achievement progress. For example, a challengeId, or another achievementId
Optional array of tag ids to filter events by. Only events with all specified tags will count towards the achievement progress.
Controls whether the query should only match events within the achievement's community context. When true (default), only community-specific events are included.
The status of the achievement
archived, draft, expired, live, scheduled The organisations that the achievement is available as a template for
Whether the achievement is a global template
When this achievement was created
When this achievement was last updated
The current user's progress on this achievement
Show child attributes
The status of the user's progress on this achievement
completed, in-progress, locked, not-started, repeatable, skipped The number of times the achievement has been completed in the past by the user
x >= 0Whether the achievement is claimable by the user, if applicable
Whether the achievement has been claimed by the user, if applicable
When progress was last updated for this achievement
Points earned by the user for this achievement
x >= 0Reward assets earned by the user for this achievement
Show child attributes
Used to describe an entity
Show child attributes
The title of the entity
The description of the entity
Light theme images
Dark theme images
A reward asset redeemable
Show child attributes
rich-text Configurable form fields to collect additional user information when user redeems the reward. Each field (e.g., email, phone, address) is defined by a variable config that specifies its type, validation rules, and display order.
Show child attributes
The ID of the variable config that defines the data type, validation rules, and UI rendering
Whether this variable must be filled out by the user before proceeding
The display order position of this variable in the form or UI
x >= 1Instructions for redeeming this reward. HTML is supported.
The URL of an image to display with the instructions
The email address of the support team
The phone number of the support team
The URL of the support team
achievement, action, auth, blog, challenge, community, custom, game, leaderboard, organisation, points, post, referral, reward, shop, social, social-connection, streak, user, variable, xp achievement-completion, facebook-comment, facebook-follow, facebook-like, image-analysis-object-detection, image-analysis-receipt-detection, instagram-follow, instagram-like, instagram-comment, instagram-share, instagram-post, interaction-engage-with-content, interaction-external-link, interaction-image-upload, interaction-spot-object, platform-comment-on-post, platform-complete-achievement, platform-generative-action, platform-like-post, platform-play-game, platform-validate-event, question-multiple-choice, question-open-ended, question-rate-your-experience, question-secret-access-code, question-select-date, question-select-from-images, question-select-value-in-range, question-select-from-list, question-closed-ended, question-vote, spotify-follow, spotify-listen, spotify-save, tiktok-follow, tiktok-watch, tiktok-post, youtube-like, youtube-comment, youtube-subscribe, action-completion, skip-action, 42-school, api-auth-link, api-token-link, apple, asgardeo, atlassian, auth0, authentik, azure-ad-b2c, azure-ad, azure-devops, battlenet, beyondidentity, box, boxyhq-saml, bungie, click-up, cognito, coinbase, descope, discord, dribbble, dropbox, duende-identity-server6, email, eveonline, facebook, faceit, foursquare, freshbooks, fusionauth, github, gitlab, google, hubspot, identity-server4, instagram, kakao, keycloak, line, linkedin, mailchimp, mailru, mastodon, mattermost, medium, naver, netlify, notion, okta, onelogin, organisation-oidc, osso, osu, passage, patreon, pinterest, pipedrive, reddit, salesforce, slack, spotify, strava, tiktok, todoist, trakt, twitch, twitter, united-effects, vk, wikimedia, wordpress, workos, yandex, youtube, zitadel, zoho, zoom, blog-comment, blog-like, blog-share, blog-view, challenge-started, challenge-completion, challenge-unlock, community-visit, parental-approval-requested, parental-approval-approved, parental-approval-rejected, custom, game-started, game-completed, leaderboard-finish, invite-admin-user, points-credit, points-spend, post-comment, post-like, post-view, reward-redemption, reward-allocation-purchase, reward-giveaway-winner, reward-claim, reward-distribution, manual-distribution, referral-link-used, shop-purchase, share-challenge-details, share-challenge-results, share-community, share-reward, share-post, share-profile, share-anything, streak-extended, profile-picture-added, bio-added, variable-captured, xp-gained, xp-total, xp-leaderboard-topper Additional communities this reward asset belongs to/is available in
Reward entries earned by the user for this achievement
Show child attributes
Used to describe an entity
Show child attributes
The title of the entity
The description of the entity
Light theme images
Dark theme images
Additional communities this reward entry belongs to/is available in
The status of the reward entry
pending, unchecked, won, lost The reward assets if the user won
Show child attributes
Used to describe an entity
Show child attributes
The title of the entity
The description of the entity
Light theme images
Show child attributes
The url of the primary image for this theme mode
The url of the secondary image for this theme mode
Dark theme images
Show child attributes
A reward asset redeemable
Show child attributes
rich-text Configurable form fields to collect additional user information when user redeems the reward. Each field (e.g., email, phone, address) is defined by a variable config that specifies its type, validation rules, and display order.
Show child attributes
The ID of the variable config that defines the data type, validation rules, and UI rendering
Whether this variable must be filled out by the user before proceeding
The display order position of this variable in the form or UI
x >= 1Instructions for redeeming this reward. HTML is supported.
The URL of an image to display with the instructions
The email address of the support team
The phone number of the support team
The URL of the support team
achievement, action, auth, blog, challenge, community, custom, game, leaderboard, organisation, points, post, referral, reward, shop, social, social-connection, streak, user, variable, xp achievement-completion, facebook-comment, facebook-follow, facebook-like, image-analysis-object-detection, image-analysis-receipt-detection, instagram-follow, instagram-like, instagram-comment, instagram-share, instagram-post, interaction-engage-with-content, interaction-external-link, interaction-image-upload, interaction-spot-object, platform-comment-on-post, platform-complete-achievement, platform-generative-action, platform-like-post, platform-play-game, platform-validate-event, question-multiple-choice, question-open-ended, question-rate-your-experience, question-secret-access-code, question-select-date, question-select-from-images, question-select-value-in-range, question-select-from-list, question-closed-ended, question-vote, spotify-follow, spotify-listen, spotify-save, tiktok-follow, tiktok-watch, tiktok-post, youtube-like, youtube-comment, youtube-subscribe, action-completion, skip-action, 42-school, api-auth-link, api-token-link, apple, asgardeo, atlassian, auth0, authentik, azure-ad-b2c, azure-ad, azure-devops, battlenet, beyondidentity, box, boxyhq-saml, bungie, click-up, cognito, coinbase, descope, discord, dribbble, dropbox, duende-identity-server6, email, eveonline, facebook, faceit, foursquare, freshbooks, fusionauth, github, gitlab, google, hubspot, identity-server4, instagram, kakao, keycloak, line, linkedin, mailchimp, mailru, mastodon, mattermost, medium, naver, netlify, notion, okta, onelogin, organisation-oidc, osso, osu, passage, patreon, pinterest, pipedrive, reddit, salesforce, slack, spotify, strava, tiktok, todoist, trakt, twitch, twitter, united-effects, vk, wikimedia, wordpress, workos, yandex, youtube, zitadel, zoho, zoom, blog-comment, blog-like, blog-share, blog-view, challenge-started, challenge-completion, challenge-unlock, community-visit, parental-approval-requested, parental-approval-approved, parental-approval-rejected, custom, game-started, game-completed, leaderboard-finish, invite-admin-user, points-credit, points-spend, post-comment, post-like, post-view, reward-redemption, reward-allocation-purchase, reward-giveaway-winner, reward-claim, reward-distribution, manual-distribution, referral-link-used, shop-purchase, share-challenge-details, share-challenge-results, share-community, share-reward, share-post, share-profile, share-anything, streak-extended, profile-picture-added, bio-added, variable-captured, xp-gained, xp-total, xp-leaderboard-topper Additional communities this reward asset belongs to/is available in
XP earned by the user for this achievement
x >= 0The type of the progress node, which determines how the progress is calculated
sum, count, logical_and, logical_or, unknown Whether this node's condition has been met by the user
Current progress value for this node
Target value to reach for this node
Progress of any child conditions, in the same tree structure as the achievement's criteria conditions
When the achievement was completed by the user, if applicable
When the achievement progress will next reset, if applicable
A reward distribution for an entity
Show child attributes
Number of points awarded
x >= 0Amount of XP awarded for completion
x >= 0Reward items available
Show child attributes
The unique identifier of the reward
Used to describe an entity
Show child attributes
The title of the entity
The description of the entity
The type of reward allocation (assets or entries)
assets, entries Amount of this reward to distribute
x >= 0Total supply available for this reward
x >= 0Number of items still available for distribution
x >= 0Method for reward selection
all, priority, random, select, Number of rewards to receive
x >= 0ID of the distribution event
The id of the community this achievement belongs to
Whether the achievement is featured
When this achievement becomes available to the user
When this achievement expires
Was this page helpful?