List Loyalty Tier Rewards

GET/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards

Use it in a workflow

Add a step and choose the Voucherify connector.
Pick the List Loyalty Tier Rewards action (under Loyalties).
Fill in the fields below, then reference the result from later steps as {{listLoyaltyTierRewards.response.data}}.

Request

Path parameters

campaignIdstringrequired

Unique campaign ID or name.

loyaltyTierIdstringrequired

Unique loyalty tier ID.

Response

Returns 200 with an object. Read it in later steps with {{listLoyaltyTierRewards.response.data.<field>}}.

objectstring

The type of the object represented by JSON. This object stores information about loyalty tier rewards in a dictionary.

Default "list"

data_refstring

Identifies the name of the attribute that contains the array of loyalty tier reward objects.

Default "data"

dataarray<object>

Contains array of loyalty tier reward objects.

rewardobjectrequired11 fields

assignmentobjectrequired

objectenumrequired

The type of the object represented by JSON. This object stores information about the loyalty tier reward.

One ofloyalty_tier_rewardDefault "loyalty_tier_reward"

totalinteger

Total number of loyalty tier reward objects.

json

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "reward": {
        "object": "reward",
        "id": "rew_nIy4gHpQHle2c3pNMwuj7G6j",
        "name": "string",
        "stock": 0,
        "redeemed": 0,
        "attributes": {
          "image_url": "string",
          "description": "string"
        },
        "metadata": {},
        "type": "CAMPAIGN",
        "parameters": null,
        "created_at": "2022-08-11T14:49:22.586Z",
        "updated_at": "2022-08-11T16:01:34.885Z"
      },
      "assignment": {},
      "object": "loyalty_tier_reward"
    }
  ],
  "total": 0
}

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.

Was this page helpful?