Authorizations
Headers
The language to return the rewards in. If not provided, the default language for the organisation will be used.
Query Parameters
Required range:
1 <= x <= 100
Required range:
x >= 0
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/templates/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": {
"instructions": "<string>",
"instructionsImageUrl": "<string>",
"supportEmail": "jsmith@example.com",
"supportPhoneNumber": "<string>",
"supportUrl": "<string>",
"type": "<string>",
"additionalInformation": [
{
"variableConfigId": "<string>",
"required": true,
"position": 2
}
],
"redeemByDate": "<string>",
"autoRedeem": false,
"content": "<string>"
},
"featured": true,
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"status": "archived",
"drawsAt": "<string>",
"startsAt": "<string>",
"expiresAt": "<string>",
"isManualGiveaway": true,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": "<string>",
"updatedBy": "<string>"
}
]
}
Get a paginated list of reward templates available to your organisation.
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/templates/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": {
"instructions": "<string>",
"instructionsImageUrl": "<string>",
"supportEmail": "jsmith@example.com",
"supportPhoneNumber": "<string>",
"supportUrl": "<string>",
"type": "<string>",
"additionalInformation": [
{
"variableConfigId": "<string>",
"required": true,
"position": 2
}
],
"redeemByDate": "<string>",
"autoRedeem": false,
"content": "<string>"
},
"featured": true,
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"status": "archived",
"drawsAt": "<string>",
"startsAt": "<string>",
"expiresAt": "<string>",
"isManualGiveaway": true,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": "<string>",
"updatedBy": "<string>"
}
]
}
The language to return the rewards in. If not provided, the default language for the organisation will be used.
1 <= x <= 100
x >= 0
Was this page helpful?