Authorizations
Headers
The language to return the actions in. If not provided, the default language for the organisation will be used.
Query Parameters
Required range:
1 <= x <= 100
Required range:
x >= 0
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>"
}
]
}
Retrieve a paginated list of 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>"
}
]
}
The language to return the actions in. If not provided, the default language for the organisation will be used.
1 <= x <= 100
x >= 0
Was this page helpful?