Action Participations
Auth Config
Campaigns
Challenge Groups
Challenges
Feature Flags
Languages
Leaderboards
Legal Policies
Me
Posts
Third Party Config
Get my reward entry by id
Copy
Ask AI
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/integration/me/reward-entries/{rewardEntryId} \
--header 'x-api-token: <api-key>'Copy
Ask AI
{
"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>"
}
]
}Me
Get my reward entry by id
Retrieve a reward entry by its ID for the current user.
GET
/
me
/
reward-entries
/
{rewardEntryId}
Get my reward entry by id
Copy
Ask AI
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/integration/me/reward-entries/{rewardEntryId} \
--header 'x-api-token: <api-key>'Copy
Ask AI
{
"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>"
}
]
}Authorizations
Headers
The language to return the reward entry in. If not provided, the default language for the organisation will be used.
Path Parameters
Response
Successful response
A reward entry
Used to describe an entity
Show child attributes
Show child attributes
The title of the entity
The description of the entity
Additional communities this reward entry belongs to/is available in
The status of the reward entry
Available options:
pending, unchecked, won, lost The reward assets if the user won
Show child attributes
Show child attributes
Used to describe an entity
Show child attributes
Show child attributes
The title of the entity
The description of the entity
A reward asset redeemable
- Reward Asset Redeemable Rich Text
- Reward Asset Redeemable Code
- RewardAssetRedeemableBadge
Show child attributes
Show child attributes
Available options:
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
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
Required range:
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
Available options:
achievement, action, auth, blog, challenge, community, custom, game, leaderboard, organisation, points, post, referral, reward, shop, social, social-connection, streak, user, variable, xp Available options:
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
Was this page helpful?
⌘I