Skip to main content
GET
/
v1
/
rewards
/
{rewardId}
Get Reward
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/rewards/{rewardId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "rew_nIy4gHpQHle2c3pNMwuj7G6j",
  "name": "<string>",
  "stock": 123,
  "redeemed": 123,
  "attributes": {
    "image_url": "<string>",
    "description": "<string>"
  },
  "metadata": {},
  "type": "CAMPAIGN",
  "parameters": {
    "campaign": {
      "id": "<string>",
      "balance": 123,
      "type": "DISCOUNT_COUPONS"
    }
  },
  "created_at": "2022-08-11T14:49:22.586Z",
  "updated_at": "2022-08-11T16:01:34.885Z",
  "object": "reward"
}

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required
Authorization
string
header
required

Path Parameters

rewardId
string
required
Example:

Response

id
string
required
Example:
name
string
required
stock
integer | null
required
redeemed
integer | null
required
metadata
object
required
type
enum<string>
required
Available options:
CAMPAIGN,
COIN,
MATERIAL
created_at
string<date-time>
required
Example:
updated_at
string<date-time> | null
required
Example:
object
enum<string>
default:reward
required
Available options:
reward
attributes
object
parameters
object
  • Digital
  • Pay with Points
  • Material