Skip to main content
GET
/
actions
/
{actionId}
Get action by ID
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/actions/{actionId} \
  --header 'x-api-token: <api-key>'
{
  "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,
  "previousAction": "<string>",
  "nextAction": "<string>",
  "stats": {
    "totalXp": 123
  },
  "reward": {
    "points": 1,
    "completionXp": 1,
    "items": [
      {
        "id": "<string>",
        "details": {
          "title": "<string>",
          "description": "<string>",
          "light": {
            "primaryImageUrl": "<string>",
            "secondaryImageUrl": "<string>"
          },
          "dark": {
            "primaryImageUrl": "<string>",
            "secondaryImageUrl": "<string>"
          }
        },
        "type": "assets",
        "amountToDistribute": 1,
        "totalSupply": 1,
        "remainingSupply": 1
      }
    ],
    "rewardSelectionMethod": "all",
    "numberOfRewardsToReceive": 1,
    "distributionEventId": "<string>"
  },
  "userState": {
    "criteriaMet": true,
    "status": "completed",
    "statusMessage": "<string>",
    "eligibleXp": 123,
    "earnedXp": 123,
    "attempts": 123,
    "output": "<any>",
    "unmetCriteriaMessage": "<string>"
  },
  "participations": [
    {
      "id": "<string>",
      "criteriaMet": true,
      "output": "<any>",
      "status": "pending",
      "participatedAt": "<string>",
      "processingStartedAt": "<string>",
      "processedAt": "<string>",
      "unmetCriteriaMessage": "<string>",
      "processingFailedMessage": "<string>"
    }
  ]
}

Authorizations

x-api-token
string
header
required

Headers

x-language
string

The language to return the action in. If not provided, the default language for the organisation will be used.

Path Parameters

actionId
string
required

Response

Successful response

An action

id
string
required

The id of the action

organisationId
string
required

The organisation that the action belongs to

communityId
string
required

The community that the action belongs to

allocationId
string
required

The allocation this action is assigned to. This can be set to a challenge only at the moment.

allocatedTo
enum<string>
required

The entity type this action is allocated to. This can be set to a 'challenge' only at the moment.

Available options:
achievement,
action,
community,
challenge,
post,
reward,
reward-asset,
reward-entry
position
number
required

The display position of this action

category
enum<string>
required

The category of this action

Available options:
nudj,
discord,
facebook,
imageAnalysis,
instagram,
interaction,
linkedin,
question,
platform,
spotify,
tiktok,
twitter,
youtube
key
enum<string>
required

The specific type of this action

Available options:
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
details
object
required

Used to describe an entity The details of this action such as title, description, bannerUrl, logoUrl

progressPeriod
enum<string>
required

The progress period of the action

Available options:
daily,
weekly,
monthly,
yearly,
open
maxCompletionsPerPeriod
required

The maximum number of completions per period for the action

Required range: x >= 0
attributes
object
required

The attributes of an action The specific attributes for this action type. This must symantically match the key of this action. A multiple choice question with configurable options and correct answer validation. The question text is stored in the details.title field of the action, while technical configuration remains in attributes.

  • Multiple Choice Question
  • Open Ended Question
  • Rate Your Experience Question
  • Secret Access Code Question
  • Select From Images Question
  • Select From List Question
  • Single Fixed Answer Question
  • Vote Question
  • Select A Date Question
  • Select Value In Range Question
  • Engage With Content Interaction
  • Image Upload Interaction
  • Spot Object Action
  • Object Detection Action Attributes
  • Receipt Detection Action Attributes
  • Facebook Comment Action Attributes
  • Facebook Follow Action Attributes
  • Facebook Like Action Attributes
  • Instagram Follow Action Attributes
  • Instagram Like Action Attributes
  • Instagram Comment Action Attributes
  • Instagram Share Action Attributes
  • Instagram Post Action Attributes
  • Comment On Post Action Attributes
  • Complete Achievement Action Attributes
  • Generative Action Attributes
  • Like Post Action Attributes
  • Play Game Action Attributes
  • Validate Event Action Attributes
  • Spotify Follow Action Attributes
  • Spotify Listen Action Attributes
  • Spotify Save Action Attributes
  • Youtube Comment Action Attributes
  • Youtube Subscribe Action Attributes
  • Youtube Like Action Attributes
  • TikTok Follow Action Attributes
  • TikTok Post Video With Hashtag Action Attributes
  • TikTok Watch Video Action Attributes
config
object
required

Used to configure an action The configuration settings for this action

videoMetadata
object
required

Video metadata for actions with video content

createdAt
string
required

The date when this action was created

stats
object
required
reward
object
required

A reward distribution for an entity

userState
object
required
participations
ActionParticipationStatus · object[]
required

History of all user attempts and interactions with this action

actionGroupId
string | null

The action group this action belongs to

actionGroupIndex
number | null

The index of this action within its action group

availableAsTemplateForOrganisations
string[] | null

List of organisation IDs that can use this action as a template

isGlobalTemplate
boolean | null

Indicates if this action is available as a template globally across all organisations

previousAction
string | null

ID of the action that precedes this one in sequence

nextAction
string | null

ID of the action that follows this one in sequence

I