Get paginated campaigns

Retrieve a paginated list of campaigns.

GET /campaigns

Get paginated campaigns

cURL

curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/campaigns \
  --header 'x-api-token: <api-key>'

200

{
  "totalCount": 123,
  "edges": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "name": "<string>",
      "startDate": "<string>",
      "endDate": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<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

200

application/json

Successful response

totalCount · number · required

edges · Campaign · object[] · required

Show child attributes