Skip to main content
GET
/
rewards
Get paginated rewards
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/rewards \
  --header 'x-api-token: <api-key>'
{
  "totalCount": 123,
  "edges": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "communityId": "<string>",
      "additionalCommunityIds": [
        "<string>"
      ],
      "details": {
        "title": "<any>",
        "description": "<any>",
        "light": "<any>",
        "dark": "<any>"
      },
      "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": "rich-text",
        "additionalInformation": [
          {
            "variableConfigId": "<string>",
            "required": true,
            "position": 2
          }
        ],
        "redeemByDate": "<string>",
        "autoRedeem": false,
        "content": "<string>"
      },
      "featured": true,
      "tags": [
        {
          "id": "<string>",
          "organisationId": "<string>",
          "value": "<string>",
          "config": {
            "filtering": [
              "<any>"
            ],
            "display": [
              "<any>"
            ],
            "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",
      "drawsAt": "<string>",
      "startsAt": "<string>",
      "expiresAt": "<string>",
      "isManualGiveaway": true,
      "availableAsTemplateForOrganisations": [
        "<string>"
      ],
      "isGlobalTemplate": true,
      "metadata": {},
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "challenges": [
        {
          "id": "<string>",
          "organisationId": "<string>",
          "communityId": "<string>",
          "additionalCommunityIds": [
            "<string>"
          ],
          "details": {
            "title": "<any>",
            "description": "<any>",
            "light": "<any>",
            "dark": "<any>"
          },
          "progressPeriod": "daily",
          "maxCompletionsPerPeriod": 1,
          "numberOfActions": 1,
          "actionIds": [
            "<string>"
          ],
          "challengeType": "survey",
          "enabledForSingleView": true,
          "actionGroups": [
            {
              "id": "<string>",
              "parentGroupId": "<string>",
              "type": "single",
              "displayType": "list",
              "details": {
                "title": "<any>",
                "description": "<any>",
                "light": "<any>",
                "dark": "<any>"
              }
            }
          ],
          "status": "archived",
          "startDate": "<string>",
          "endDate": "<string>",
          "featured": true,
          "threadId": "<string>",
          "isSkippable": true,
          "isLinear": true,
          "unlockPrice": 1,
          "tags": [
            {
              "id": "<string>",
              "organisationId": "<string>",
              "value": "<string>",
              "config": {
                "filtering": [
                  "<any>"
                ],
                "display": [
                  "<any>"
                ],
                "iconifyIcon": "<string>"
              },
              "createdAt": "<string>",
              "updatedAt": "<string>"
            }
          ],
          "campaigns": [
            {
              "id": "<string>",
              "organisationId": "<string>",
              "name": "<string>",
              "startDate": "<string>",
              "endDate": "<string>",
              "status": "archived",
              "createdAt": "<string>",
              "updatedAt": "<string>"
            }
          ],
          "availableAsTemplateForOrganisations": [
            "<string>"
          ],
          "isGlobalTemplate": true,
          "startsAt": "<string>",
          "expiresAt": "<string>",
          "groupIds": [
            "<string>"
          ],
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "videoConfig": {
            "videoUrl": "<string>",
            "isVideoEnabled": true
          },
          "actions": [
            {
              "id": "<string>",
              "organisationId": "<string>",
              "communityId": "<string>",
              "allocationId": "<string>",
              "allocatedTo": "achievement",
              "actionGroupId": "<string>",
              "actionGroupIndex": 123,
              "position": 123,
              "category": "nudj",
              "key": "facebook-comment",
              "details": {
                "title": "<string>",
                "description": "<string>",
                "light": {
                  "primaryImageUrl": "<any>",
                  "secondaryImageUrl": "<any>"
                },
                "dark": {
                  "primaryImageUrl": "<any>",
                  "secondaryImageUrl": "<any>"
                }
              },
              "progressPeriod": "daily",
              "maxCompletionsPerPeriod": 1,
              "attributes": "<any>",
              "config": {
                "isOptional": true,
                "socialValidation": "validation-on",
                "prerequisites": {
                  "requiredActionCount": 123,
                  "actionIds": [
                    "<string>"
                  ]
                },
                "requiresCorrectAnswer": true
              },
              "videoMetadata": {
                "startsAtMs": 1,
                "shouldPause": true,
                "validatesAtMs": 1,
                "endsAtMs": 1
              },
              "createdAt": "<string>",
              "availableAsTemplateForOrganisations": [
                "<string>"
              ],
              "isGlobalTemplate": true,
              "previousAction": "<string>",
              "nextAction": "<string>",
              "stats": {
                "totalXp": 123
              },
              "reward": {
                "points": 1,
                "completionXp": 1,
                "items": [
                  {
                    "id": "<string>",
                    "details": {},
                    "type": "assets",
                    "amountToDistribute": 1,
                    "totalSupply": 1,
                    "remainingSupply": 1
                  }
                ],
                "rewardSelectionMethod": "all",
                "numberOfRewardsToReceive": 1,
                "distributionEventId": "<string>"
              },
              "userState": {
                "criteriaMet": true,
                "status": "completed",
                "statusMessage": "<string>",
                "eligibleXp": 123,
                "earnedXp": 123,
                "attempts": 123,
                "output": "<any>",
                "unmetCriteriaMessage": "<string>"
              },
              "participations": [
                {
                  "id": "<string>",
                  "criteriaMet": true,
                  "output": "<any>",
                  "status": "pending",
                  "participatedAt": "<string>",
                  "processingStartedAt": "<string>",
                  "processedAt": "<string>",
                  "unmetCriteriaMessage": "<string>",
                  "processingFailedMessage": "<string>"
                }
              ]
            }
          ],
          "community": {
            "id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "slug": "<string>",
            "logo": "<string>"
          },
          "participantStats": {
            "startedCount": 1,
            "completedCount": 1
          },
          "stats": {
            "totalXp": 1,
            "totalActionsCount": 1
          },
          "reward": {
            "points": 1,
            "completionXp": 1,
            "items": [
              {
                "id": "<string>",
                "details": {},
                "type": "assets",
                "amountToDistribute": 1,
                "totalSupply": 1,
                "remainingSupply": 1
              }
            ],
            "rewardSelectionMethod": "all",
            "numberOfRewardsToReceive": 1,
            "distributionEventId": "<string>"
          },
          "userState": {
            "status": "completed",
            "completionsInPeriod": 0,
            "totalCompletions": 0,
            "keysContributed": 0,
            "latestAttempt": {
              "eligibleXp": 0,
              "actionsCompletedCount": 0,
              "startedAt": "<string>",
              "earnedXp": 0,
              "earnedPoints": 0,
              "earnedRewardAssets": [
                {
                  "rewardAssetId": "<string>",
                  "rewardId": "<string>"
                }
              ],
              "earnedRewardEntries": [
                {
                  "rewardEntryId": "<string>",
                  "rewardId": "<string>",
                  "amount": 1
                }
              ],
              "completionTime": 0,
              "successRate": 0
            },
            "historicAttempts": []
          }
        }
      ],
      "achievements": [
        {
          "id": "<string>",
          "organisationId": "<string>",
          "communityId": "<string>",
          "details": {
            "title": "<any>",
            "description": "<any>",
            "light": "<any>",
            "dark": "<any>"
          },
          "progressPeriod": "daily",
          "displayMode": "default",
          "tags": [
            "<string>"
          ],
          "campaigns": [
            "<string>"
          ],
          "criteria": {
            "type": "<any>",
            "parameters": "<any>"
          },
          "queries": [
            {
              "type": "event",
              "alias": "<string>",
              "parameters": {
                "eventName": "<string>",
                "eventCategory": "achievement",
                "eventSubCategory": "achievement-completion",
                "eventSourceId": "<string>",
                "tags": [
                  "<string>"
                ]
              },
              "isCommunityScoped": true
            }
          ],
          "queryDescriptions": {},
          "status": "archived",
          "featured": true,
          "availableAsTemplateForOrganisations": [
            "<string>"
          ],
          "isGlobalTemplate": true,
          "startsAt": "<string>",
          "expiresAt": "<string>",
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "userState": {
            "status": "completed",
            "completedAt": "<string>",
            "timesCompleted": 1,
            "isClaimable": true,
            "isClaimed": true,
            "updatedAt": "<string>",
            "earnedPoints": 1,
            "earnedRewardAssets": [
              {
                "id": "<any>",
                "organisationId": "<any>",
                "communityId": "<any>",
                "rewardId": "<any>",
                "allocationId": "<any>",
                "userId": "<any>",
                "details": "<any>",
                "redeemable": "<any>",
                "eventCategory": "<any>",
                "eventSubCategory": "<any>",
                "eventSourceId": "<any>",
                "tags": "<any>",
                "campaigns": "<any>",
                "metadata": "<any>",
                "claimedAt": "<any>",
                "redeemedAt": "<any>",
                "expiresAt": "<any>",
                "createdAt": "<any>",
                "updatedAt": "<any>",
                "additionalCommunityIds": "<any>"
              }
            ],
            "earnedRewardEntries": [
              {
                "id": "<string>",
                "organisationId": "<string>",
                "communityId": "<string>",
                "rewardId": "<string>",
                "userId": "<string>",
                "rewardAssetIds": [
                  "<string>"
                ],
                "details": {
                  "title": "<any>",
                  "description": "<any>",
                  "light": "<any>",
                  "dark": "<any>"
                },
                "totalEntries": 123,
                "entries": [
                  {
                    "allocationId": "<string>",
                    "amount": 123,
                    "createdAt": "<string>"
                  }
                ],
                "tags": [
                  "<string>"
                ],
                "campaigns": [
                  "<string>"
                ],
                "checkByDate": "<string>",
                "checkedAt": "<string>",
                "drawnAt": "<string>",
                "createdAt": "<string>",
                "updatedAt": "<string>",
                "additionalCommunityIds": [
                  "<string>"
                ],
                "status": "pending",
                "rewardAssets": [
                  {
                    "id": "<any>",
                    "organisationId": "<any>",
                    "communityId": "<any>",
                    "rewardId": "<any>",
                    "allocationId": "<any>",
                    "userId": "<any>",
                    "details": "<any>",
                    "redeemable": "<any>",
                    "eventCategory": "<any>",
                    "eventSubCategory": "<any>",
                    "eventSourceId": "<any>",
                    "tags": "<any>",
                    "campaigns": "<any>",
                    "metadata": "<any>",
                    "claimedAt": "<any>",
                    "redeemedAt": "<any>",
                    "expiresAt": "<any>",
                    "createdAt": "<any>",
                    "updatedAt": "<any>",
                    "additionalCommunityIds": "<any>"
                  }
                ]
              }
            ],
            "earnedXp": 1,
            "progressResetsAt": "<string>",
            "type": "sum",
            "isComplete": true,
            "currentValue": 123,
            "targetValue": 123,
            "conditions": [
              {}
            ]
          },
          "stats": {
            "completedCount": 1
          },
          "reward": {
            "points": 1,
            "completionXp": 1,
            "items": [
              {
                "id": "<string>",
                "details": {},
                "type": "assets",
                "amountToDistribute": 1,
                "totalSupply": 1,
                "remainingSupply": 1
              }
            ],
            "rewardSelectionMethod": "all",
            "numberOfRewardsToReceive": 1,
            "distributionEventId": "<string>"
          }
        }
      ],
      "initialAssetSupply": 1,
      "initialEntrySupply": 1,
      "distributedAssetCount": 1,
      "distributedEntryCount": 1,
      "remainingAssetSupply": 1,
      "remainingEntrySupply": 1,
      "remainingShopAssetSupply": 1,
      "remainingShopEntrySupply": 1,
      "userEntryCount": 0,
      "userAssetCount": 0
    }
  ]
}

Authorizations

x-api-token
string
header
required

Headers

x-language
string

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

Query Parameters

limit
integer
default:10
Required range: 1 <= x <= 100
skip
integer
default:0
Required range: x >= 0
sort
string
communityId
string
allocationId
string
verified
boolean
isShop
boolean
type
string
status
string
eventCategory
string
eventSubCategory
string
eventName
string
displayMode
string
fromDate
string
toDate
string
isGlobalTemplate
boolean
key
string
progressPeriod
string

Response

Successful response

totalCount
number
required
edges
Reward · object[]
required
I