v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB

Rewards

Get Reward

Retrieve a reward by the reward ID.

get/v1/rewards/{rewardId}

Response

Returns a reward object if a valid identifier was provided.

idstring required

Unique reward ID, assigned by Voucherify.

namestring required

Reward name.

stockinteger nullable required

Configurable for material rewards. The number of units of the product that you want to share as a reward. Use this parameter to code a stock-taking logic.

redeemedinteger nullable required

Defines the number of already invoked (successful) reward redemptions.

metadataobject required

The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format.

type'CAMPAIGN' | 'COIN' | 'MATERIAL' required

Reward type.

created_atstring date-time required

Timestamp representing the date and time when the reward 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 was updated. The value is shown in the ISO 8601 format.

object'reward' required

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

Example response

{
  "id": "rew_nIy4gHpQHle2c3pNMwuj7G6j",
  "parameters": {
    "product": {
      "id": "prod_0b7d7dfb05cbe5c616",
      "sku_id": "sku_0b7d7dfb090be5c619"
    }
  },
  "created_at": "2022-08-11T14:49:22.586Z",
  "updated_at": "2022-08-11T16:01:34.885Z"
}