Skip to main content
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>'
{
  "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>"
}

Authorizations

​
x-api-token
string
header
required

Headers

​
x-language
string

The language to return the reward in. If not provided, the default language for the organisation will be used.

Path Parameters

​
rewardId
string
required

Response

Successful response

A reward

​
id
string
required

The unique identifier of the reward

​
organisationId
string
required

The organisation this reward belongs to

​
communityId
string
required

The community this reward belongs to

​
additionalCommunityIds
string[]
required

The additional communities this reward is available in

​
details
Details · object
required

Used to describe an entity

​
assetPointsPrice
number
required

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
​
assetPointsSwapValue
number
required

[Not yet implemented] The points value received when swapping this reward asset back. If 0, asset cannot be swapped.

Required range: x >= 0
​
entryPointsPrice
number
required

The points cost to acquire one entry for this reward. Must be > 0 if allocationsType is entries-only or assets-and-entries.

Required range: x >= 0
​
assetsSupply
required

The total supply of assets available for this reward. Must be > 0 if allocationsType is assets-only or assets-and-entries.

Required range: x >= 0
​
entriesSupply
required

The total supply of entries available for this reward. Must be > 0 if allocationsType is entries-only or assets-and-entries.

Required range: x >= 0
​
maxAssetsPerUser
required

Maximum 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 >= 1
​
maxEntriesPerUser
required

Maximum 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 >= 1
​
allocationsType
enum<string>
required

The 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
​
isSharedAssetsSupply
boolean
required

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.

​
isSharedEntriesSupply
boolean
required

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.

​
allocations
RewardAllocation · object[]
required

The allocations configured for this reward

​
redemptionConfig
RewardRedemptionConfigRichText · object
required

A reward redemption config rich text

​
tags
Tag · object[]
required

The tags the reward is linked to

​
campaigns
Campaign · object[]
required

The campaigns the reward is linked to

​
status
enum<string>
required

The current status of this reward

Available options:
archived,
draft,
expired,
live,
scheduled
​
isManualGiveaway
boolean
required

Whether the giveaway should be manual (true) or automatic (false)

​
availableAsTemplateForOrganisations
string[]
required

The organisations that the reward is available as a template for

​
isGlobalTemplate
boolean
required

Whether the reward is a global template

​
metadata
object
required

Additional metadata for the reward

​
createdAt
string
required

When this reward was created

​
updatedAt
string
required

When this reward was last updated

​
community
object
required

Details of the community this reward belongs to

​
challenges
Challenge · object[]
required

Array of challenges associated with this reward

​
achievements
Achievement · object[]
required

Array of achievements associated with this reward

​
initialAssetSupply
required

Initial total supply of assets configured for this reward when created

Required range: x >= 0
​
initialEntrySupply
required

Initial total supply of entries configured for this reward when created

Required range: x >= 0
​
distributedAssetCount
number
required

Number of assets that have been distributed for this reward

Required range: x >= 0
​
distributedEntryCount
number
required

Number of entries that have been distributed for this reward

Required range: x >= 0
​
remainingAssetSupply
required

Number of assets still available for distribution

Required range: x >= 0
​
remainingEntrySupply
required

Number of entries still available for distribution

Required range: x >= 0
​
remainingShopAssetSupply
required

Number of assets still available for purchase through the shop

Required range: x >= 0
​
remainingShopEntrySupply
required

Number of entries still available for purchase through the shop

Required range: x >= 0
​
userEntryCount
number
default:0
required

Number of entries the current user has for this reward

Required range: x >= 0
​
userAssetCount
number
default:0
required

Number of assets the current user has for this reward

Required range: x >= 0
​
featured
boolean | null

Whether this reward is featured

​
drawsAt
string | null

When this reward giveaway will be drawn

​
startsAt
string | null

When this reward becomes available

​
expiresAt
string | null

When this reward expires (or giveaway takes place)