VOvoucherifyio
Rewards

Get a reward by ID

<Warning>

<Badge color="yellow">BETA endpoint</Badge>

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

</Warning>

Returns a single reward by its ID.

get/v2/loyalties/rewards/{rewardId}

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/rewards/{rewardId}
  • Auth
    none required

Path parameters

idstring required

Unique reward identifier, prefixed with lrew_.

Response

The reward.

idstring required

Unique reward identifier, prefixed with lrew_.

namestring required

Display name of the reward.

type'MATERIAL' | 'DIGITAL' required

Reward type.

status'ACTIVE' | 'DRAFT' | 'INACTIVE' | 'DELETED' required

Current lifecycle status of the reward.

start_datestring date-time

Date from which the reward is available, or null when not set.

end_datestring date-time

Date until which the reward is available, or null when not set.

metadataobject required

Arbitrary key-value metadata attached to the reward. Empty object when not set.

created_atstring date-time required

Timestamp when the reward was created (ISO-8601).

updated_atstring date-time

Timestamp when the reward was last updated (ISO-8601), or null when never updated.

objectstring required

Object type marker; always reward.

Example response

{
  "validity_hours": {
    "daily": [
      {
        "start_time": "09:00",
        "end_time": "17:00"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.