Get reward by id
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId} \
--header 'x-api-token: <api-key>'import requests
url = "https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId}"
headers = {"x-api-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-token': '<api-key>'}};
fetch('https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId}")
.header("x-api-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": "rich-text",
"additionalInformation": [
{
"variableConfigId": "<string>",
"required": true,
"position": 2
}
],
"autoRedeem": false,
"content": "<string>",
"instructions": "<string>",
"instructionsImageUrl": "<string>",
"supportEmail": "jsmith@example.com",
"supportPhoneNumber": "<string>",
"supportUrl": "<string>",
"redeemByDate": "<string>"
},
"tags": [
{
"id": "<string>",
"organisationId": "<string>",
"value": "<string>",
"config": {
"filtering": [
"achievement"
],
"display": [
"achievement"
],
"iconifyIcon": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"campaigns": [
{
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"status": "archived",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"status": "archived",
"isManualGiveaway": true,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"community": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"descriptionConfig": {
"content": "<string>",
"disableLineClamp": true,
"maxLines": 5.5
},
"logo": "<string>"
},
"challenges": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"additionalCommunityIds": [
"<string>"
],
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"progressPeriod": "daily",
"maxCompletionsPerPeriod": 1,
"numberOfActions": 1,
"actionIds": [
"<string>"
],
"actionGroups": [
{
"id": "<string>",
"type": "single",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"parentGroupId": "<string>",
"displayType": "list"
}
],
"status": "archived",
"isLinear": true,
"unlockPrice": 1,
"tags": [
{
"id": "<string>",
"organisationId": "<string>",
"value": "<string>",
"config": {
"filtering": [
"achievement"
],
"display": [
"achievement"
],
"iconifyIcon": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"startedCount": 1,
"completedCount": 1,
"uniqueUsersStartedCount": 1,
"uniqueUsersCompletedCount": 1,
"campaigns": [
{
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"status": "archived",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"groupIds": [
"<string>"
],
"createdAt": "<string>",
"videoConfig": {
"videoUrl": "<string>",
"isVideoEnabled": true
},
"xpConfig": {
"total": 1,
"knowledge": 1,
"creativity": 1,
"loyalty": 1,
"influence": 1,
"participation": 1,
"contribution": 1
},
"rewardDistribution": {
"points": 1,
"xp": 1,
"rewardSelectionMethod": "all",
"distributionEventId": "<string>",
"rewardAllocations": [
{
"rewardId": "<string>",
"allocationId": "<string>",
"allocationType": "assets",
"amountToDistribute": 2
}
],
"numberOfRewardsToReceive": 1
},
"actionsRewardDistribution": {
"points": 1,
"xp": 1,
"rewardAllocations": [
{
"rewardId": "<string>",
"allocationId": "<string>",
"allocationType": "assets",
"amountToDistribute": 2
}
]
},
"actions": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"allocationId": "<string>",
"allocatedTo": "achievement",
"position": 123,
"category": "nudj",
"key": "facebook-comment",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"progressPeriod": "daily",
"maxCompletionsPerPeriod": 1,
"attributes": {
"key": "question-multiple-choice",
"question": "<string>",
"options": [
{
"id": "<string>",
"label": "<string>"
}
],
"minimumNumberOfAnswersRequired": 2,
"maximumNumberOfAnswersAllowed": 2
},
"config": {
"isOptional": true,
"socialValidation": "validation-on",
"prerequisites": {
"requiredActionCount": 123,
"actionIds": [
"<string>"
]
},
"requiresCorrectAnswer": true
},
"xpConfig": {
"total": 1,
"knowledge": 1,
"creativity": 1,
"loyalty": 1,
"influence": 1,
"participation": 1,
"contribution": 1
},
"videoMetadata": {
"startsAtMs": 1,
"shouldPause": true,
"validatesAtMs": 1,
"endsAtMs": 1
},
"createdAt": "<string>",
"rewardDistribution": {
"points": 1,
"xp": 1,
"rewardSelectionMethod": "all",
"distributionEventId": "<string>",
"rewardAllocations": [
{
"rewardId": "<string>",
"allocationId": "<string>",
"allocationType": "assets",
"amountToDistribute": 2
}
],
"numberOfRewardsToReceive": 1
},
"rewards": [
{
"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
}
],
"userState": {
"status": "abandoned",
"criteriaMet": true,
"statusMessage": "<string>",
"eligibleXp": 123,
"earnedXp": 123,
"attempts": 123,
"output": {
"key": "interaction-external-link",
"eventId": "<string>"
},
"unmetCriteriaMessage": "<string>",
"metCriteriaMessage": "<string>"
},
"participations": [
{
"id": "<string>",
"criteriaMet": true,
"output": {
"key": "interaction-external-link",
"eventId": "<string>"
},
"status": "pending",
"participatedAt": "<string>",
"processingStartedAt": "<string>",
"processedAt": "<string>",
"unmetCriteriaMessage": "<string>",
"metCriteriaMessage": "<string>",
"processingFailedMessage": "<string>"
}
],
"actionGroupId": "<string>",
"actionGroupIndex": 123,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"previousAction": "<string>",
"nextAction": "<string>"
}
],
"rewards": [
{
"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
}
],
"userState": {
"status": "abandoned",
"completionsInPeriod": 0,
"totalCompletions": 0,
"keysContributed": 0,
"latestAttempt": {
"eligibleXp": 0,
"actionsCompletedCount": 0,
"earnedXp": 0,
"earnedPoints": 0,
"earnedRewardAssets": [
{
"rewardAssetId": "<string>",
"rewardId": "<string>"
}
],
"earnedRewardEntries": [
{
"rewardEntryId": "<string>",
"rewardId": "<string>",
"amount": 1
}
],
"completionTime": 0,
"successRate": 0,
"startedAt": "<string>"
},
"historicAttempts": [],
"challengeProgressId": "<string>"
},
"challengeType": "survey",
"enabledForSingleView": true,
"startDate": "<string>",
"endDate": "<string>",
"featured": true,
"threadId": "<string>",
"isSkippable": true,
"startsAt": "<string>",
"expiresAt": "<string>",
"updatedAt": "<string>",
"community": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"descriptionConfig": {
"content": "<string>",
"disableLineClamp": true,
"maxLines": 5.5
},
"logo": "<string>"
}
}
],
"achievements": [
{
"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>",
"rewardDistribution": {
"points": 1,
"xp": 1,
"rewardSelectionMethod": "all",
"distributionEventId": "<string>",
"rewardAllocations": [
{
"rewardId": "<string>",
"allocationId": "<string>",
"allocationType": "assets",
"amountToDistribute": 2
}
],
"numberOfRewardsToReceive": 1
},
"userState": {
"status": "abandoned",
"timesCompleted": 1,
"isClaimable": true,
"isClaimed": true,
"updatedAt": "<string>",
"earnedPoints": 1,
"earnedRewardAssets": [
{
"rewardAssetId": "<string>",
"rewardId": "<string>"
}
],
"earnedRewardEntries": [
{
"rewardEntryId": "<string>",
"rewardId": "<string>",
"amount": 1
}
],
"earnedXp": 1,
"type": "sum",
"isComplete": true,
"currentValue": 123,
"targetValue": 123,
"conditions": "<array>",
"completedAt": "<string>",
"progressResetsAt": "<string>"
},
"stats": {
"completedCount": 1
},
"rewards": [
{
"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
}
],
"communityId": "<string>",
"featured": true,
"startsAt": "<string>",
"expiresAt": "<string>",
"community": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"descriptionConfig": {
"content": "<string>",
"disableLineClamp": true,
"maxLines": 5.5
},
"logo": "<string>"
}
}
],
"initialAssetSupply": 1,
"initialEntrySupply": 1,
"distributedAssetCount": 1,
"distributedEntryCount": 1,
"remainingAssetSupply": 1,
"remainingEntrySupply": 1,
"remainingShopAssetSupply": 1,
"remainingShopEntrySupply": 1,
"userEntryCount": 0,
"userAssetCount": 0,
"featured": true,
"drawsAt": "<string>",
"startsAt": "<string>",
"expiresAt": "<string>"
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Rewards
Get reward by id
Retrieve a reward by its ID.
GET
/
rewards
/
{rewardId}
Get reward by id
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId} \
--header 'x-api-token: <api-key>'import requests
url = "https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId}"
headers = {"x-api-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-token': '<api-key>'}};
fetch('https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId}")
.header("x-api-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.nudj.cx/api/v2/integration/rewards/{rewardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": "rich-text",
"additionalInformation": [
{
"variableConfigId": "<string>",
"required": true,
"position": 2
}
],
"autoRedeem": false,
"content": "<string>",
"instructions": "<string>",
"instructionsImageUrl": "<string>",
"supportEmail": "jsmith@example.com",
"supportPhoneNumber": "<string>",
"supportUrl": "<string>",
"redeemByDate": "<string>"
},
"tags": [
{
"id": "<string>",
"organisationId": "<string>",
"value": "<string>",
"config": {
"filtering": [
"achievement"
],
"display": [
"achievement"
],
"iconifyIcon": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"campaigns": [
{
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"status": "archived",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"status": "archived",
"isManualGiveaway": true,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"community": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"descriptionConfig": {
"content": "<string>",
"disableLineClamp": true,
"maxLines": 5.5
},
"logo": "<string>"
},
"challenges": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"additionalCommunityIds": [
"<string>"
],
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"progressPeriod": "daily",
"maxCompletionsPerPeriod": 1,
"numberOfActions": 1,
"actionIds": [
"<string>"
],
"actionGroups": [
{
"id": "<string>",
"type": "single",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"parentGroupId": "<string>",
"displayType": "list"
}
],
"status": "archived",
"isLinear": true,
"unlockPrice": 1,
"tags": [
{
"id": "<string>",
"organisationId": "<string>",
"value": "<string>",
"config": {
"filtering": [
"achievement"
],
"display": [
"achievement"
],
"iconifyIcon": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"startedCount": 1,
"completedCount": 1,
"uniqueUsersStartedCount": 1,
"uniqueUsersCompletedCount": 1,
"campaigns": [
{
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"status": "archived",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"groupIds": [
"<string>"
],
"createdAt": "<string>",
"videoConfig": {
"videoUrl": "<string>",
"isVideoEnabled": true
},
"xpConfig": {
"total": 1,
"knowledge": 1,
"creativity": 1,
"loyalty": 1,
"influence": 1,
"participation": 1,
"contribution": 1
},
"rewardDistribution": {
"points": 1,
"xp": 1,
"rewardSelectionMethod": "all",
"distributionEventId": "<string>",
"rewardAllocations": [
{
"rewardId": "<string>",
"allocationId": "<string>",
"allocationType": "assets",
"amountToDistribute": 2
}
],
"numberOfRewardsToReceive": 1
},
"actionsRewardDistribution": {
"points": 1,
"xp": 1,
"rewardAllocations": [
{
"rewardId": "<string>",
"allocationId": "<string>",
"allocationType": "assets",
"amountToDistribute": 2
}
]
},
"actions": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"allocationId": "<string>",
"allocatedTo": "achievement",
"position": 123,
"category": "nudj",
"key": "facebook-comment",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"progressPeriod": "daily",
"maxCompletionsPerPeriod": 1,
"attributes": {
"key": "question-multiple-choice",
"question": "<string>",
"options": [
{
"id": "<string>",
"label": "<string>"
}
],
"minimumNumberOfAnswersRequired": 2,
"maximumNumberOfAnswersAllowed": 2
},
"config": {
"isOptional": true,
"socialValidation": "validation-on",
"prerequisites": {
"requiredActionCount": 123,
"actionIds": [
"<string>"
]
},
"requiresCorrectAnswer": true
},
"xpConfig": {
"total": 1,
"knowledge": 1,
"creativity": 1,
"loyalty": 1,
"influence": 1,
"participation": 1,
"contribution": 1
},
"videoMetadata": {
"startsAtMs": 1,
"shouldPause": true,
"validatesAtMs": 1,
"endsAtMs": 1
},
"createdAt": "<string>",
"rewardDistribution": {
"points": 1,
"xp": 1,
"rewardSelectionMethod": "all",
"distributionEventId": "<string>",
"rewardAllocations": [
{
"rewardId": "<string>",
"allocationId": "<string>",
"allocationType": "assets",
"amountToDistribute": 2
}
],
"numberOfRewardsToReceive": 1
},
"rewards": [
{
"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
}
],
"userState": {
"status": "abandoned",
"criteriaMet": true,
"statusMessage": "<string>",
"eligibleXp": 123,
"earnedXp": 123,
"attempts": 123,
"output": {
"key": "interaction-external-link",
"eventId": "<string>"
},
"unmetCriteriaMessage": "<string>",
"metCriteriaMessage": "<string>"
},
"participations": [
{
"id": "<string>",
"criteriaMet": true,
"output": {
"key": "interaction-external-link",
"eventId": "<string>"
},
"status": "pending",
"participatedAt": "<string>",
"processingStartedAt": "<string>",
"processedAt": "<string>",
"unmetCriteriaMessage": "<string>",
"metCriteriaMessage": "<string>",
"processingFailedMessage": "<string>"
}
],
"actionGroupId": "<string>",
"actionGroupIndex": 123,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"previousAction": "<string>",
"nextAction": "<string>"
}
],
"rewards": [
{
"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
}
],
"userState": {
"status": "abandoned",
"completionsInPeriod": 0,
"totalCompletions": 0,
"keysContributed": 0,
"latestAttempt": {
"eligibleXp": 0,
"actionsCompletedCount": 0,
"earnedXp": 0,
"earnedPoints": 0,
"earnedRewardAssets": [
{
"rewardAssetId": "<string>",
"rewardId": "<string>"
}
],
"earnedRewardEntries": [
{
"rewardEntryId": "<string>",
"rewardId": "<string>",
"amount": 1
}
],
"completionTime": 0,
"successRate": 0,
"startedAt": "<string>"
},
"historicAttempts": [],
"challengeProgressId": "<string>"
},
"challengeType": "survey",
"enabledForSingleView": true,
"startDate": "<string>",
"endDate": "<string>",
"featured": true,
"threadId": "<string>",
"isSkippable": true,
"startsAt": "<string>",
"expiresAt": "<string>",
"updatedAt": "<string>",
"community": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"descriptionConfig": {
"content": "<string>",
"disableLineClamp": true,
"maxLines": 5.5
},
"logo": "<string>"
}
}
],
"achievements": [
{
"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>",
"rewardDistribution": {
"points": 1,
"xp": 1,
"rewardSelectionMethod": "all",
"distributionEventId": "<string>",
"rewardAllocations": [
{
"rewardId": "<string>",
"allocationId": "<string>",
"allocationType": "assets",
"amountToDistribute": 2
}
],
"numberOfRewardsToReceive": 1
},
"userState": {
"status": "abandoned",
"timesCompleted": 1,
"isClaimable": true,
"isClaimed": true,
"updatedAt": "<string>",
"earnedPoints": 1,
"earnedRewardAssets": [
{
"rewardAssetId": "<string>",
"rewardId": "<string>"
}
],
"earnedRewardEntries": [
{
"rewardEntryId": "<string>",
"rewardId": "<string>",
"amount": 1
}
],
"earnedXp": 1,
"type": "sum",
"isComplete": true,
"currentValue": 123,
"targetValue": 123,
"conditions": "<array>",
"completedAt": "<string>",
"progressResetsAt": "<string>"
},
"stats": {
"completedCount": 1
},
"rewards": [
{
"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
}
],
"communityId": "<string>",
"featured": true,
"startsAt": "<string>",
"expiresAt": "<string>",
"community": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"descriptionConfig": {
"content": "<string>",
"disableLineClamp": true,
"maxLines": 5.5
},
"logo": "<string>"
}
}
],
"initialAssetSupply": 1,
"initialEntrySupply": 1,
"distributedAssetCount": 1,
"distributedEntryCount": 1,
"remainingAssetSupply": 1,
"remainingEntrySupply": 1,
"remainingShopAssetSupply": 1,
"remainingShopEntrySupply": 1,
"userEntryCount": 0,
"userAssetCount": 0,
"featured": true,
"drawsAt": "<string>",
"startsAt": "<string>",
"expiresAt": "<string>"
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Authorizations
Headers
The language to return the reward in. If not provided, the default language for the organisation will be used.
Path Parameters
Response
Successful response
A reward
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 points cost to acquire one asset of this reward. Must be > 0 if allocationsType is assets-only or assets-and-entries.
Required range:
x >= 0[Not yet implemented] The points value received when swapping this reward asset back. If 0, asset cannot be swapped.
Required range:
x >= 0The points cost to acquire one entry for this reward. Must be > 0 if allocationsType is entries-only or assets-and-entries.
Required range:
x >= 0The total supply of assets available for this reward. Must be > 0 if allocationsType is assets-only or assets-and-entries.
Required range:
x >= 0The total supply of entries available for this reward. Must be > 0 if allocationsType is entries-only or assets-and-entries.
Required range:
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.
Required range:
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.
Required range:
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.
Available options:
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
A reward redemption config rich text
- RewardRedemptionConfigRichText
- RewardRedemptionConfigCode
- Reward Redemption Config Badge
- RewardRedemptionConfigShopify
Show child attributes
Show child attributes
The tags the reward is linked to
Show child attributes
Show child attributes
The campaigns the reward is linked to
Show child attributes
Show child attributes
The current status of this reward
Available options:
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
Additional metadata for the reward
Show child attributes
Show child attributes
When this reward was created
When this reward was last updated
Details of the community this reward belongs to
Show child attributes
Show child attributes
Array of challenges associated with this reward
Show child attributes
Show child attributes
Array of achievements associated with this reward
Show child attributes
Show child attributes
Initial total supply of assets configured for this reward when created
Required range:
x >= 0Initial total supply of entries configured for this reward when created
Required range:
x >= 0Number of assets that have been distributed for this reward
Required range:
x >= 0Number of entries that have been distributed for this reward
Required range:
x >= 0Number of assets still available for distribution
Required range:
x >= 0Number of entries still available for distribution
Required range:
x >= 0Number of assets still available for purchase through the shop
Required range:
x >= 0Number of entries still available for purchase through the shop
Required range:
x >= 0Number of entries the current user has for this reward
Required range:
x >= 0Number of assets the current user has for this reward
Required range:
x >= 0Whether 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?