curl --request GET \
--url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "list",
"data_ref": "data",
"data": [
{
"reward": {
"id": "rew_QuWYsBNB2G3fikffjnl0G3gH",
"name": "API - Testing",
"type": "CAMPAIGN",
"parameters": {
"campaign": {
"id": "camp_jcErmtGAOmHUAy0oUgkwKnPZ",
"balance": 500,
"type": "LOYALTY_PROGRAM"
}
},
"stock": null,
"redeemed": null,
"created_at": "2022-08-25T09:32:04.579424+00:00",
"updated_at": "2022-08-25T09:33:46.680639+00:00",
"metadata": {
"Type": "Second campaign"
},
"object": "reward"
},
"assignment": {
"id": "rewa_3Z2sP0bmqcL0ggU28GvFeHU3",
"reward_id": "rew_QuWYsBNB2G3fikffjnl0G3gH",
"related_object_id": "camp_fkZ28pe7DUAEmmabofkxHI8N",
"related_object_type": "campaign",
"parameters": {
"loyalty": {
"points": 40
}
},
"created_at": "2022-11-23T22:11:58.759092+00:00",
"updated_at": null,
"object": "reward_assignment"
},
"object": "loyalty_tier_reward"
},
{
"reward": {
"id": "rew_XoDgmQ2HZX7qPM6aIEuslObo",
"name": "Material",
"type": "MATERIAL",
"parameters": {
"product": {
"id": "prod_0b15f6b9f650c16990",
"sku_id": "sku_0b1621b319d248b79f"
}
},
"stock": 2,
"redeemed": 1,
"attributes": {
"image_url": "{{internalVoucherifyURL}}",
"description": "Archie's Series"
},
"created_at": "2022-08-29T06:02:36.753873+00:00",
"updated_at": "2022-11-08T08:01:26.883166+00:00",
"metadata": {
"Type": "Material"
},
"object": "reward"
},
"assignment": {
"id": "rewa_Or6gWZ5ASuGkBLjOf0IyiD4k",
"reward_id": "rew_XoDgmQ2HZX7qPM6aIEuslObo",
"related_object_id": "camp_fkZ28pe7DUAEmmabofkxHI8N",
"related_object_type": "campaign",
"parameters": {
"loyalty": {
"points": 30
}
},
"created_at": "2022-11-23T22:11:58.759092+00:00",
"updated_at": null,
"object": "reward_assignment"
},
"object": "loyalty_tier_reward"
},
{
"reward": {
"id": "rew_MVXA2kV7lZ1zC057WUaTrvNz",
"name": "100 Points = $20",
"type": "COIN",
"parameters": {
"coin": {
"exchange_ratio": 20,
"points_ratio": 100
}
},
"stock": null,
"redeemed": null,
"attributes": {},
"created_at": "2022-09-09T06:41:54.496035+00:00",
"updated_at": null,
"metadata": {},
"object": "reward"
},
"assignment": {
"id": "rewa_nMXB59qGTNYawMT8eP8M4oUp",
"reward_id": "rew_MVXA2kV7lZ1zC057WUaTrvNz",
"related_object_id": "camp_fkZ28pe7DUAEmmabofkxHI8N",
"related_object_type": "campaign",
"created_at": "2022-11-09T11:01:21.065681+00:00",
"updated_at": null,
"object": "reward_assignment"
},
"object": "loyalty_tier_reward"
}
],
"total": 3
}Get available rewards for a given tier.
curl --request GET \
--url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "list",
"data_ref": "data",
"data": [
{
"reward": {
"id": "rew_QuWYsBNB2G3fikffjnl0G3gH",
"name": "API - Testing",
"type": "CAMPAIGN",
"parameters": {
"campaign": {
"id": "camp_jcErmtGAOmHUAy0oUgkwKnPZ",
"balance": 500,
"type": "LOYALTY_PROGRAM"
}
},
"stock": null,
"redeemed": null,
"created_at": "2022-08-25T09:32:04.579424+00:00",
"updated_at": "2022-08-25T09:33:46.680639+00:00",
"metadata": {
"Type": "Second campaign"
},
"object": "reward"
},
"assignment": {
"id": "rewa_3Z2sP0bmqcL0ggU28GvFeHU3",
"reward_id": "rew_QuWYsBNB2G3fikffjnl0G3gH",
"related_object_id": "camp_fkZ28pe7DUAEmmabofkxHI8N",
"related_object_type": "campaign",
"parameters": {
"loyalty": {
"points": 40
}
},
"created_at": "2022-11-23T22:11:58.759092+00:00",
"updated_at": null,
"object": "reward_assignment"
},
"object": "loyalty_tier_reward"
},
{
"reward": {
"id": "rew_XoDgmQ2HZX7qPM6aIEuslObo",
"name": "Material",
"type": "MATERIAL",
"parameters": {
"product": {
"id": "prod_0b15f6b9f650c16990",
"sku_id": "sku_0b1621b319d248b79f"
}
},
"stock": 2,
"redeemed": 1,
"attributes": {
"image_url": "{{internalVoucherifyURL}}",
"description": "Archie's Series"
},
"created_at": "2022-08-29T06:02:36.753873+00:00",
"updated_at": "2022-11-08T08:01:26.883166+00:00",
"metadata": {
"Type": "Material"
},
"object": "reward"
},
"assignment": {
"id": "rewa_Or6gWZ5ASuGkBLjOf0IyiD4k",
"reward_id": "rew_XoDgmQ2HZX7qPM6aIEuslObo",
"related_object_id": "camp_fkZ28pe7DUAEmmabofkxHI8N",
"related_object_type": "campaign",
"parameters": {
"loyalty": {
"points": 30
}
},
"created_at": "2022-11-23T22:11:58.759092+00:00",
"updated_at": null,
"object": "reward_assignment"
},
"object": "loyalty_tier_reward"
},
{
"reward": {
"id": "rew_MVXA2kV7lZ1zC057WUaTrvNz",
"name": "100 Points = $20",
"type": "COIN",
"parameters": {
"coin": {
"exchange_ratio": 20,
"points_ratio": 100
}
},
"stock": null,
"redeemed": null,
"attributes": {},
"created_at": "2022-09-09T06:41:54.496035+00:00",
"updated_at": null,
"metadata": {},
"object": "reward"
},
"assignment": {
"id": "rewa_nMXB59qGTNYawMT8eP8M4oUp",
"reward_id": "rew_MVXA2kV7lZ1zC057WUaTrvNz",
"related_object_id": "camp_fkZ28pe7DUAEmmabofkxHI8N",
"related_object_type": "campaign",
"created_at": "2022-11-09T11:01:21.065681+00:00",
"updated_at": null,
"object": "reward_assignment"
},
"object": "loyalty_tier_reward"
}
],
"total": 3
}The access token received from the authorization server in the OAuth 2.0 flow.
Unique campaign ID or name.
"camp_rRsfatlwN7unSeUIJDCYedal"
Unique loyalty tier ID.
"promo_2EnAik6Jt7dKTOMkRTIgEjZH"
Returns a dictionary of loyalty tier reward objects.
Response body schema for GET v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards.
The type of the object represented by JSON. This object stores information about loyalty tier rewards in a dictionary.
Identifies the name of the attribute that contains the array of loyalty tier reward objects.
Contains array of loyalty tier reward objects.
Show child attributes
Total number of loyalty tier reward objects.
Was this page helpful?