Skip to main content
GET
/
action-participations
Get paginated action participations
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/action-participations \
  --header 'x-api-token: <api-key>'
{
  "totalCount": 123,
  "edges": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "communityId": "<string>",
      "actionId": "<string>",
      "userId": "<string>",
      "actionAttributes": {
        "question": "<string>",
        "options": [
          {
            "id": "<string>",
            "label": "<string>"
          }
        ],
        "minimumNumberOfAnswersRequired": 2,
        "maximumNumberOfAnswersAllowed": 2
      },
      "allocationId": "<string>",
      "participationStatuses": [
        {
          "id": "<string>",
          "criteriaMet": true,
          "output": {
            "eventId": "<string>"
          },
          "participatedAt": "<string>",
          "processingStartedAt": "<string>",
          "processedAt": "<string>",
          "unmetCriteriaMessage": "<string>",
          "metCriteriaMessage": "<string>",
          "processingFailedMessage": "<string>"
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "actionGroupId": "<string>"
    }
  ]
}

Authorizations

​
x-api-token
string
header
required

Query Parameters

​
limit
integer
default:10
Required range: 1 <= x <= 100
​
skip
integer
default:0
Required range: x >= 0
​
sort
string
​
search
string
​
communityId
string
​
allocationId
string
​
featured
boolean
​
verified
boolean
​
isShop
boolean
​
type
string
​
status
string
​
eventCategory
string
​
eventSubCategory
string
​
eventName
string
​
displayMode
string
​
fromDate
string
​
toDate
string
​
isGlobalTemplate
boolean
​
key
string
​
progressPeriod
string
​
expand
string
​
redeemableType
string

Response

Successful response

​
totalCount
number
required
​
edges
ActionParticipation · object[]
required