Skip to main content
GET
/
templates
/
achievements
Get paginated achievement templates
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/admin/templates/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>"
        }
      },
      "tags": [
        "<string>"
      ],
      "campaigns": [
        "<string>"
      ],
      "criteria": {
        "type": "<string>",
        "parameters": {
          "query": "<string>",
          "attribute": "<string>",
          "value": 123
        }
      },
      "queries": [
        {
          "type": "<string>",
          "alias": "<string>",
          "parameters": {
            "eventName": "<string>",
            "eventSourceId": "<string>",
            "tags": [
              "<string>"
            ]
          },
          "isCommunityScoped": true
        }
      ],
      "queryDescriptions": {},
      "availableAsTemplateForOrganisations": [
        "<string>"
      ],
      "isGlobalTemplate": true,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "rewardDistribution": {
        "points": 1,
        "xp": 1,
        "distributionEventId": "<string>",
        "rewardAllocations": [
          {
            "rewardId": "<string>",
            "allocationId": "<string>",
            "amountToDistribute": 2
          }
        ],
        "numberOfRewardsToReceive": 1
      },
      "createdBy": "<string>",
      "updatedBy": "<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
​
search
string
​
communityId
string
​
allocationId
string
​
featured
boolean
​
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
​
expand
string
​
redeemableType
string

Response

Successful response

​
totalCount
number
required
​
edges
Achievement · object[]
required