Skip to main content
GET
/
action-participations
/
{actionParticipationId}
Get action participation by ID
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/admin/action-participations/{actionParticipationId} \
  --header 'x-api-token: <api-key>'
{
  "id": "<string>",
  "organisationId": "<string>",
  "communityId": "<string>",
  "actionId": "<string>",
  "userId": "<string>",
  "actionCategory": "nudj",
  "actionKey": "facebook-comment",
  "actionAttributes": "<any>",
  "allocationId": "<string>",
  "allocatedTo": "achievement",
  "actionGroupId": "<string>",
  "participationStatuses": [
    {
      "id": "<string>",
      "criteriaMet": true,
      "output": "<any>",
      "status": "pending",
      "participatedAt": "<string>",
      "processingStartedAt": "<string>",
      "processedAt": "<string>"
    }
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

​
x-api-token
string
header
required

Path Parameters

​
actionParticipationId
string
required

Response

Successful response

An action participation

​
id
string
required
​
organisationId
string
required
​
communityId
string
required
​
actionId
string
required
​
userId
string
required
​
actionCategory
enum<string>
required
Available options:
nudj,
discord,
facebook,
imageAnalysis,
instagram,
interaction,
linkedin,
question,
platform,
spotify,
tiktok,
twitter,
youtube
​
actionKey
enum<string>
required
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
​
actionAttributes
object
required

The attributes of an 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
  • Action Attributes
  • 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
​
allocationId
string
required
​
allocatedTo
enum<string>
required
Available options:
achievement,
action,
community,
challenge,
post,
reward,
reward-asset,
reward-entry
​
participationStatuses
ActionParticipationStatus · object[]
required
​
createdAt
string
required
​
updatedAt
string
required
​
actionGroupId
string | null
⌘I