Skip to main content
GET
/
actions
Get paginated actions
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/admin/actions \
  --header 'x-api-token: <api-key>'
{
  "totalCount": 123,
  "edges": [
    {
      "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": "<string>",
          "secondaryImageUrl": "<string>"
        },
        "dark": {
          "primaryImageUrl": "<string>",
          "secondaryImageUrl": "<string>"
        }
      },
      "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,
      "createdBy": "<string>",
      "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
communityId
string
allocationId
string
isGlobalTemplate
boolean
key
string

Response

Successful response

totalCount
number
required
edges
Action · object[]
required
I