Achievements
Action Participations
Actions
Auth Config
Challenge Groups
Challenges
Communities
Feature Flags
Game
Leaderboards
- GETGet aggregated leaderboard data
- GETGet paginated leaderboard configurations
- Get leaderboards configs leaderboardConfigId
- GETGet distribution details for a leaderboard config
- PATCHUpdate a leaderboard configuration
- POSTCreate a new leaderboard configuration
- POSTCreate default leaderboard configs
- POSTAssign distribution details to a leaderboard config
Legal Policies
Rewards
- GETGet paginated rewards
- GETGet reward by ID
- GETGet paginated reward entries for a specific reward
- GETGet paginated reward redemption values for a specific reward
- POSTCreate a reward
- POSTUpdate a reward by id
- POSTProcess manual reward distribution
- POSTProcess manual reward giveaway
- POSTProcess reward redemption values from CSV
Tags
Teams
Templates
Third Party Config
Users
Variables
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/rewards \
--header 'x-api-token: <api-key>'{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"additionalCommunityIds": [
"<string>"
],
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"assetPointsPrice": 1,
"assetPointsSwapValue": 1,
"entryPointsPrice": 1,
"assetsSupply": 1,
"entriesSupply": 1,
"maxAssetsPerUser": 2,
"maxEntriesPerUser": 2,
"allocationsType": "assets-only",
"isSharedAssetsSupply": true,
"isSharedEntriesSupply": true,
"allocations": [
{
"id": "<string>",
"allocationType": "assets",
"supply": 1,
"amountToDistribute": 2,
"distributed": 1,
"isShop": true,
"isLive": true
}
],
"redemptionConfig": {
"type": "<string>",
"additionalInformation": [
{
"variableConfigId": "<string>",
"required": true,
"position": 2
}
],
"autoRedeem": false,
"content": "<string>",
"instructions": "<string>",
"instructionsImageUrl": "<string>",
"supportEmail": "[email protected]",
"supportPhoneNumber": "<string>",
"supportUrl": "<string>",
"redeemByDate": "<string>"
},
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"status": "archived",
"isManualGiveaway": true,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": "<string>",
"updatedBy": "<string>",
"featured": true,
"drawsAt": "<string>",
"startsAt": "<string>",
"expiresAt": "<string>"
}
]
}Get paginated rewards
Retrieve a paginated list of rewards.
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/rewards \
--header 'x-api-token: <api-key>'{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"additionalCommunityIds": [
"<string>"
],
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"assetPointsPrice": 1,
"assetPointsSwapValue": 1,
"entryPointsPrice": 1,
"assetsSupply": 1,
"entriesSupply": 1,
"maxAssetsPerUser": 2,
"maxEntriesPerUser": 2,
"allocationsType": "assets-only",
"isSharedAssetsSupply": true,
"isSharedEntriesSupply": true,
"allocations": [
{
"id": "<string>",
"allocationType": "assets",
"supply": 1,
"amountToDistribute": 2,
"distributed": 1,
"isShop": true,
"isLive": true
}
],
"redemptionConfig": {
"type": "<string>",
"additionalInformation": [
{
"variableConfigId": "<string>",
"required": true,
"position": 2
}
],
"autoRedeem": false,
"content": "<string>",
"instructions": "<string>",
"instructionsImageUrl": "<string>",
"supportEmail": "[email protected]",
"supportPhoneNumber": "<string>",
"supportUrl": "<string>",
"redeemByDate": "<string>"
},
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"status": "archived",
"isManualGiveaway": true,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": "<string>",
"updatedBy": "<string>",
"featured": true,
"drawsAt": "<string>",
"startsAt": "<string>",
"expiresAt": "<string>"
}
]
}Authorizations
Headers
The language to return the rewards in. If not provided, the default language for the organisation will be used.
Query Parameters
1 <= x <= 100x >= 0Response
Successful response
Show child attributes
Show child attributes
The unique identifier of the reward
The organisation this reward belongs to
The community this reward belongs to
The additional communities this reward is available in
Used to describe an entity
Show child attributes
Show child attributes
The title of the entity
The description of the entity
The points cost to acquire one asset of this reward. Must be > 0 if allocationsType is assets-only or assets-and-entries.
x >= 0[Not yet implemented] The points value received when swapping this reward asset back. If 0, asset cannot be swapped.
x >= 0The points cost to acquire one entry for this reward. Must be > 0 if allocationsType is entries-only or assets-and-entries.
x >= 0The total supply of assets available for this reward. Must be > 0 if allocationsType is assets-only or assets-and-entries.
x >= 0The total supply of entries available for this reward. Must be > 0 if allocationsType is entries-only or assets-and-entries.
x >= 0Maximum number of assets a single user can acquire through any distribution. Must be > 0 if allocationsType is assets-only or assets-and-entries.
x >= 1Maximum number of entries a single user can acquire through any distribution. Must be > 0 if allocationsType is entries-only or assets-and-entries.
x >= 1The type of allocations for this reward. assets-only means only assets are allocable, entries-only means only entries are allocable, and assets-and-entries means both assets and entries are allocable.
assets-only, entries-only, assets-and-entries Whether the assets supply is shared across allocations. If true, the total supply of assets across all allocations will be capped at the value set here. If false, each allocation will use its own supply value.
Whether the entries supply is shared across allocations. If true, the total supply of entries across all allocations will be capped at the value set here. If false, each allocation will use its own supply value.
The allocations configured for this reward
Show child attributes
Show child attributes
The ID of this allocation
The type of allocation, either assets or entries. If the reward has a type of assets-and-entries, this allocation can have both assets and entries. Otherwise, it can only have one type matching the reward's allocation type.
assets, entries The total supply of this allocation. Only used if isSharedAssetsSupply or isSharedEntriesSupply is false on the reward.
x >= 0The quantity of this specific reward to distribute when this allocation is selected. For example, if amountToDistribute is 3, then 3 units of this reward will be given to the recipient.
x >= 1The amount already distributed for this allocation
x >= 0Whether this allocation is for the shop
Whether this allocation is live
A reward redemption config
- RewardRedemptionConfigRichText
- RewardRedemptionConfigCode
- Reward Redemption Config Badge
Show child attributes
Show child attributes
Rich text redemption config
"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
x >= 1Whether the reward should be automatically redeemed when claimed
false
The rich text content. HTML is supported.
Instructions 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
The date by which the reward can be redeemed
Tags associated with this reward
Campaigns this reward is part of
The current status of this reward
archived, draft, expired, live, scheduled Whether the giveaway should be manual (true) or automatic (false)
The organisations that the reward is available as a template for
Whether the reward is a global template
When this reward was created
When this reward was last updated
The user who created this reward
The user who last updated this reward
Whether this reward is featured
When this reward giveaway will be drawn
When this reward becomes available
When this reward expires (or giveaway takes place)
Was this page helpful?