VOvoucherifyio
Loyalties

List Loyalty Tier Rewards

Get available rewards for a given tier.

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

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, loyalties

Response

Returns a dictionary of loyalty tier reward objects.

objectstring required

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

data_refstring required

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

totalinteger required

Total number of loyalty tier reward objects.

Example response

{
  "data": [
    {
      "reward": {
        "id": "rew_nIy4gHpQHle2c3pNMwuj7G6j",
        "parameters": {
          "product": {
            "id": "prod_0b7d7dfb05cbe5c616",
            "sku_id": "sku_0b7d7dfb090be5c619"
          }
        },
        "created_at": "2022-08-11T14:49:22.586Z",
        "updated_at": "2022-08-11T16:01:34.885Z"
      },
      "assignment": {
        "id": "rewa_PbIRoMXpwe5QhobW4JKu0VjH",
        "reward_id": "rew_C7wS9eHFDN4CIbXI5PpLSkGY",
        "created_at": "2022-08-11T14:49:22.586Z",
        "updated_at": "2022-08-11T16:01:34.885Z",
        "related_object_id": "camp_wciTvaOfYmAa3EmIIW3QpXXZ"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.