Skip to main content
GET
/
v1
/
loyalties
/
{campaignId}
/
rewards
/
{assignmentId}
Get Reward Assignment
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/rewards/{assignmentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "rewa_1gJ6VyYQI0IcnEvhArbr9XFH",
  "reward_id": "rew_injbwG52POgfpSogTlQl4hA6",
  "related_object_id": "camp_Vr97XXNOnFEUIMFymKK99FAA",
  "related_object_type": "campaign",
  "parameters": {
    "loyalty": {
      "points": 10
    }
  },
  "created_at": "2022-06-13T11:56:49.185Z",
  "updated_at": null,
  "object": "reward_assignment"
}

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

​
campaignId
string
required

The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

​
assignmentId
string
required

A unique reward assignment ID.

Example:

"rewa_m9hEAu10KsPcLhGXiHG85aY0"

Response

Returns specific reward assignment.

Response body schema for GET v1/loyalties/{campaignId}/rewards/{assignmentId}

​
id
string
required

Unique reward assignment ID, assigned by Voucherify.

Example:

"rewa_PbIRoMXpwe5QhobW4JKu0VjH"

​
reward_id
string
required

Associated reward ID.

Example:

"rew_C7wS9eHFDN4CIbXI5PpLSkGY"

​
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"

​
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"

​
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
string
required

Related object ID to which the reward was assigned.

Example:

"camp_wciTvaOfYmAa3EmIIW3QpXXZ"

​
related_object_type
enum<string>
default:campaign
required

Related object type to which the reward was assigned.

Available options:
campaign
​
parameters
object

Defines the cost of the reward.

⌘I