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",
"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": {
"key": "<string>",
"question": "<string>",
"options": [
{
"id": "<string>",
"label": "<string>"
}
],
"minimumNumberOfAnswersRequired": 2,
"maximumNumberOfAnswersAllowed": 2,
"correctAnswers": [
"<string>"
]
},
"config": {
"isOptional": true,
"socialValidation": "validation-on",
"prerequisites": {
"requiredActionCount": 123,
"actionIds": [
"<string>"
]
},
"requiresCorrectAnswer": true
},
"videoMetadata": {
"startsAtMs": 1,
"shouldPause": true,
"validatesAtMs": 1,
"endsAtMs": 1
},
"createdAt": "<string>",
"createdBy": "<string>",
"actionGroupId": "<string>",
"actionGroupIndex": 123,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"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",
"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": {
"key": "<string>",
"question": "<string>",
"options": [
{
"id": "<string>",
"label": "<string>"
}
],
"minimumNumberOfAnswersRequired": 2,
"maximumNumberOfAnswersAllowed": 2,
"correctAnswers": [
"<string>"
]
},
"config": {
"isOptional": true,
"socialValidation": "validation-on",
"prerequisites": {
"requiredActionCount": 123,
"actionIds": [
"<string>"
]
},
"requiresCorrectAnswer": true
},
"videoMetadata": {
"startsAtMs": 1,
"shouldPause": true,
"validatesAtMs": 1,
"endsAtMs": 1
},
"createdAt": "<string>",
"createdBy": "<string>",
"actionGroupId": "<string>",
"actionGroupIndex": 123,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"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 <= 100x >= 0Successful response
Show child attributes
The id of the action
The organisation that the action belongs to
The community that the action belongs to
The allocation this action is assigned to. When null, indicates this is a template action.
The entity type this action is allocated to. This can be set to a 'challenge' only at the moment.
achievement, action, community, challenge, post, reward, reward-asset, reward-entry The display position of this action
The category of this action
nudj, discord, facebook, imageAnalysis, instagram, interaction, linkedin, question, platform, spotify, tiktok, twitter, youtube The specific type of this action
facebook-comment, facebook-follow, facebook-like, image-analysis-object-detection, image-analysis-receipt-detection, instagram-follow, instagram-like, instagram-comment, instagram-share, instagram-post, interaction-engage-with-content, interaction-external-link, interaction-image-upload, interaction-spot-object, platform-comment-on-post, platform-complete-achievement, platform-generative-action, platform-like-post, platform-play-game, platform-validate-event, question-multiple-choice, question-open-ended, question-rate-your-experience, question-secret-access-code, question-select-date, question-select-from-images, question-select-value-in-range, question-select-from-list, question-closed-ended, question-vote, spotify-follow, spotify-listen, spotify-save, tiktok-follow, tiktok-watch, tiktok-post, youtube-like, youtube-comment, youtube-subscribe The details of this action such as title, description, bannerUrl, logoUrl
Show child attributes
The title of the entity
The description of the entity
The progress period of the action
daily, weekly, monthly, yearly, open The maximum number of completions per period for the action
x >= 0The attributes of an action
Show child attributes
The multiple choice question action key
"question-multiple-choice"The multiple choice question to be answered ie 'What is your favorite color?'
1The multiple choice options available to answer the question
2The minimum number of answers required
x >= 1The maximum number of answers allowed
x >= 1The correct answers for this question. This must match the ids of the options array.
The configuration settings for this action
Show child attributes
Whether this action is optional
Controls how social media validation is handled:
validation-on, validation-off, user-choice Used to configure a prerequisite for an action
Whether the action must be answered correctly to count toward challenge completion. When false, any participation counts toward completion but only correct answers earn rewards.
Video metadata for actions with video content
Show child attributes
The start time of the action in milliseconds from the start of the video
x >= 0Whether the video should pause at the validation point
The validation time in milliseconds, null if the user will validate themselves
x >= 0The end time of the action in milliseconds from the start of the video
x >= 0The date when this action was created
The action group this action belongs to
The index of this action within its action group
List of organisation IDs that can use this action as a template
Indicates if this action is available as a template globally across all organisations
Was this page helpful?