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
}

GET

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

Show child attributes

data.id

string

required

Unique reward assignment ID, assigned by Voucherify.

Example:

"rewa_PbIRoMXpwe5QhobW4JKu0VjH"

data.reward_id

string

required

Associated reward ID.

Example:

"rew_C7wS9eHFDN4CIbXI5PpLSkGY"

data.created_at

string<date-time>

required

Timestamp representing the date and time when the reward assignment was created. The value is shown in the ISO 8601 format.

Example:

"2022-08-11T14:49:22.586Z"

data.updated_at

string<date-time> | null

required

Timestamp representing the date and time when the reward assignment was updated. The value is shown in the ISO 8601 format.

Example:

"2022-08-11T16:01:34.885Z"

data.object

enum<string>

default:reward_assignment

required

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

Available options:

reward_assignment

Related object ID to which the reward was assigned.

Example:

"camp_wciTvaOfYmAa3EmIIW3QpXXZ"

Related object type to which the reward was assigned.

Available options:

campaign

data.parameters

object

Defines the cost of the reward.

Show child attributes

data.parameters.loyalty

object

required

Defines the equivalent points value of the reward.

Show child attributes

data.parameters.loyalty.points

integer

The number of points required to redeem the reward.

data.parameters.loyalty.auto_redeem

boolean | null

Determines if the reward is redeemed automatically when the customer reaches the sufficient number of points to redeem it. Value true means that the automatic reward redemption is active. Only one reward can be set to be redeemed automatically in a loyalty campaign, i.e. only one can have the value true.

total

integer

required

Total number of reward assignments.

Delete Reward Get Reward Assignment

⌘I

Introduction

Endpoints

Events

List Reward Assignments

Authorizations

Path Parameters

Query Parameters

Response