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>",
"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>",
"createdBy": "<string>",
"updatedBy": "<string>",
"communityId": "<string>",
"featured": true,
"startsAt": "<string>",
"expiresAt": "<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>",
"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>",
"createdBy": "<string>",
"updatedBy": "<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 admin user who created this achievement
The admin user who last updated this achievement
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?