Skip to main content
GET
/
v1
/
rewards
/
{rewardId}
/
assignments
List Reward Assignments
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/rewards/{rewardId}/assignments \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "rewa_PbIRoMXpwe5QhobW4JKu0VjH",
      "reward_id": "rew_C7wS9eHFDN4CIbXI5PpLSkGY",
      "related_object_id": "camp_wciTvaOfYmAa3EmIIW3QpXXZ",
      "related_object_type": "campaign",
      "parameters": {
        "loyalty": {
          "points": 15
        }
      },
      "created_at": "2022-08-17T08:13:02.507Z",
      "updated_at": null,
      "object": "reward_assignment"
    },
    {
      "id": "rewa_pJYQBXSitK2OVPK3XMXZK76X",
      "reward_id": "rew_C7wS9eHFDN4CIbXI5PpLSkGY",
      "related_object_id": "camp_jcErmtGAOmHUAy0oUgkwKnPZ",
      "related_object_type": "campaign",
      "parameters": {
        "loyalty": {
          "points": 20
        }
      },
      "created_at": "2022-08-24T11:40:22.418Z",
      "updated_at": null,
      "object": "reward_assignment"
    }
  ],
  "total": 2
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
rewardId
string
required

A unique reward ID.

Example:

"rew_2erjvECLs92GYzKbak3QkyTV"

Query Parameters

​
limit
integer

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

Required range: 1 <= x <= 100
​
page
integer

Which page of results to return. The lowest value is 1.

Required range: 1 <= x <= 100

Response

Returns a dictionary of reward assignment objects. Each object contains information regarding the resource to which the reward was assigned and the cost in loyalty points for the reward.

Response body schema for GET v1/rewards/{rewardID}/assignments.

​
object
string
default:list
required

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

​
data_ref
string
default:data
required

Identifies the name of the attribute that contains the array of reward assignments.

​
data
Reward Assignment · object[]
required
​
total
integer
required

Total number of reward assignments.

⌘I