Skip to main content
GET
/
achievements
Get paginated achievements
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/achievements \
  --header 'x-api-token: <api-key>'
{
  "totalCount": 123,
  "edges": [
    {
      "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>",
      "userState": {
        "status": "completed",
        "timesCompleted": 1,
        "isClaimable": true,
        "isClaimed": true,
        "updatedAt": "<string>",
        "earnedPoints": 1,
        "earnedRewardAssets": [
          {
            "id": "<string>",
            "organisationId": "<string>",
            "communityId": "<string>",
            "rewardId": "<string>",
            "allocationId": "<string>",
            "userId": "<string>",
            "details": {
              "title": "<string>",
              "description": "<string>",
              "light": {
                "primaryImageUrl": "<string>",
                "secondaryImageUrl": "<string>"
              },
              "dark": {
                "primaryImageUrl": "<string>",
                "secondaryImageUrl": "<string>"
              }
            },
            "redeemable": {
              "type": "rich-text",
              "additionalInformation": [
                {
                  "variableConfigId": "<string>",
                  "required": true,
                  "position": 2
                }
              ],
              "content": "<string>",
              "instructions": "<string>",
              "instructionsImageUrl": "<string>",
              "supportEmail": "[email protected]",
              "supportPhoneNumber": "<string>",
              "supportUrl": "<string>",
              "redeemByDate": "<string>"
            },
            "eventCategory": "achievement",
            "eventSubCategory": "achievement-completion",
            "tags": [
              "<string>"
            ],
            "campaigns": [
              "<string>"
            ],
            "metadata": {},
            "createdAt": "<string>",
            "updatedAt": "<string>",
            "additionalCommunityIds": [
              "<string>"
            ],
            "eventSourceId": "<string>",
            "claimedAt": "<string>",
            "redeemedAt": "<string>",
            "expiresAt": "<string>"
          }
        ],
        "earnedRewardEntries": [
          {
            "id": "<string>",
            "organisationId": "<string>",
            "communityId": "<string>",
            "rewardId": "<string>",
            "userId": "<string>",
            "details": {
              "title": "<string>",
              "description": "<string>",
              "light": {
                "primaryImageUrl": "<string>",
                "secondaryImageUrl": "<string>"
              },
              "dark": {
                "primaryImageUrl": "<string>",
                "secondaryImageUrl": "<string>"
              }
            },
            "totalEntries": 123,
            "entries": [
              {
                "allocationId": "<string>",
                "amount": 123,
                "createdAt": "<string>"
              }
            ],
            "tags": [
              "<string>"
            ],
            "campaigns": [
              "<string>"
            ],
            "createdAt": "<string>",
            "updatedAt": "<string>",
            "additionalCommunityIds": [
              "<string>"
            ],
            "status": "pending",
            "rewardAssetIds": [
              "<string>"
            ],
            "checkByDate": "<string>",
            "checkedAt": "<string>",
            "drawnAt": "<string>",
            "rewardAssets": [
              {
                "id": "<string>",
                "organisationId": "<string>",
                "communityId": "<string>",
                "rewardId": "<string>",
                "allocationId": "<string>",
                "userId": "<string>",
                "details": {
                  "title": "<string>",
                  "description": "<string>",
                  "light": {
                    "primaryImageUrl": "<string>",
                    "secondaryImageUrl": "<string>"
                  },
                  "dark": {
                    "primaryImageUrl": "<string>",
                    "secondaryImageUrl": "<string>"
                  }
                },
                "redeemable": {
                  "type": "rich-text",
                  "additionalInformation": [
                    {
                      "variableConfigId": "<string>",
                      "required": true,
                      "position": 2
                    }
                  ],
                  "content": "<string>",
                  "instructions": "<string>",
                  "instructionsImageUrl": "<string>",
                  "supportEmail": "[email protected]",
                  "supportPhoneNumber": "<string>",
                  "supportUrl": "<string>",
                  "redeemByDate": "<string>"
                },
                "eventCategory": "achievement",
                "eventSubCategory": "achievement-completion",
                "tags": [
                  "<string>"
                ],
                "campaigns": [
                  "<string>"
                ],
                "metadata": {},
                "createdAt": "<string>",
                "updatedAt": "<string>",
                "additionalCommunityIds": [
                  "<string>"
                ],
                "eventSourceId": "<string>",
                "claimedAt": "<string>",
                "redeemedAt": "<string>",
                "expiresAt": "<string>"
              }
            ]
          }
        ],
        "earnedXp": 1,
        "type": "sum",
        "isComplete": true,
        "currentValue": 123,
        "targetValue": 123,
        "conditions": "<array>",
        "completedAt": "<string>",
        "progressResetsAt": "<string>"
      },
      "stats": {
        "completedCount": 1
      },
      "reward": {
        "points": 1,
        "completionXp": 1,
        "items": [
          {
            "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
          }
        ],
        "rewardSelectionMethod": "all",
        "numberOfRewardsToReceive": 1,
        "distributionEventId": "<string>"
      },
      "communityId": "<string>",
      "featured": true,
      "startsAt": "<string>",
      "expiresAt": "<string>"
    }
  ]
}

Authorizations

x-api-token
string
header
required

Headers

x-language
string

The language to return the achievements 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
Achievement · object[]
required