VOvoucherifyio
Rewards

Get Reward Assignment

Retrieve a reward assignment.

get/v1/rewards/{rewardId}/assignments/{assignmentId}

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/rewards/{rewardId}/assignments/{assignmentId}
  • 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, rewards

Response

Returns a reward assignment object.

idstring required

Unique reward assignment ID, assigned by Voucherify.

reward_idstring required

Associated reward ID.

created_atstring date-time required

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

updated_atstring date-time nullable required

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

object'reward_assignment' required

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

related_object_idstring required

Related object ID to which the reward was assigned.

related_object_type'campaign' required

Related object type to which the reward was assigned.

Example response

{
  "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.