List Promotion Stacks in Campaign

This method enables you to list promotion stacks from a specified campaign.

GET /v1/promotions/{campaignId}/stacks

List Promotion Stacks in Campaign

cURL

curl --request GET \
  --url https://{cluster}.voucherify.io/v1/promotions/{campaignId}/stacks \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "stack_p0WhtyyDU95crobleMpRabhH",
      "name": "First stack",
      "created_at": "2022-09-22T13:03:25.740Z",
      "campaign_id": "camp_99HUWI53bVyLzPN1Fg5TBLWX",
      "object": "promotion_stack",
      "tiers": {
        "ids": [
          "promo_dJNhAEeV5sR5oPQq1UrUdnMC",
          "promo_aaAF8mVAzA0PF1igia2OC63d"
        ],
        "hierarchy_mode": "MANUAL"
      }
    },
    {
      "id": "stack_XAzn8AFR3Ks3DBPLAQxV7zHe",
      "name": "Second stack",
      "created_at": "2022-09-22T13:03:25.903Z",
      "campaign_id": "camp_99HUWI53bVyLzPN1Fg5TBLWX",
      "object": "promotion_stack",
      "tiers": {
        "ids": [
          "promo_aaAF8mVAzA0PF1igia2OC63d",
          "promo_dJNhAEeV5sR5oPQq1UrUdnMC"
        ],
        "hierarchy_mode": "MANUAL"
      }
    }
  ],
  "total": 2
}

Authorizations

X-App-Id & X-App-TokenX-Voucherify-OAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

campaignId · string · required

Unique campaign ID.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

Response

200 - application/json

Returns a list of promotion stack objects.

Response body schema for GET v1/promotions/stacks and for GET v1/promotions/{campaignId}/stacks.

object · enum<string> · default: list · required

The type of the object represented by JSON. This object stores information about promotion stacks in a dictionary.

Available options: list

data_ref · enum<string> · default: data · required

Identifies the name of the attribute that contains the array of promotion stack objects.

Available options: data

data · Promotion Stack Base · object[] · required

Contains array of promotion stack objects.

Show child attributes

total · integer · required

Total number of promotion stacks.

Required range: x >= 0