Get paginated action templates

Get a paginated list of action templates available to your organisation.

GET /templates/actions

Get paginated action templates

cURL

curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/admin/templates/actions \
  --header 'x-api-token: <api-key>'

200

{
  "totalCount": 123,
  "edges": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "communityId": "<string>",
      "allocationId": "<string>",
      "position": 123,
      "details": {
        "title": "<string>",
        "description": "<string>",
        "light": {
          "primaryImageUrl": "<string>",
          "secondaryImageUrl": "<string>"
        },
        "dark": {
          "primaryImageUrl": "<string>",
          "secondaryImageUrl": "<string>"
        }
      },
      "maxCompletionsPerPeriod": 1,
      "attributes": {
        "key": "<string>",
        "question": "<string>",
        "options": [
          {
            "id": "<string>",
            "label": "<string>"
          }
        ],
        "minimumNumberOfAnswersRequired": 2,
        "maximumNumberOfAnswersAllowed": 2,
        "correctAnswers": [
          "<string>"
        ]
      },
      "config": {
        "isOptional": true,
        "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,
        "distributionEventId": "<string>",
        "rewardAllocations": [
          {
            "rewardId": "<string>",
            "allocationId": "<string>",
            "amountToDistribute": 2
          }
        ],
        "numberOfRewardsToReceive": 1
      },
      "createdBy": "<string>",
      "actionGroupId": "<string>",
      "actionGroupIndex": 123,
      "availableAsTemplateForOrganisations": [
        "<string>"
      ],
      "isGlobalTemplate": true,
      "updatedAt": "<string>",
      "updatedBy": "<string>"
    }
  ]
}

Authorizations

x-api-token · string · header · required

Headers

x-language · string

The language to return the actions 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

200

application/json

Successful response

totalCount · number · required

edges · Action · object[] · required

Show child attributes