Skip to main content
GET
/
api
/
v2
/
rewards
/
{id}
/
Get reward details
curl --request GET \
  --url https://api.zupy.com/api/v2/rewards/{id}/ \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "points_required": 123,
    "monetary_value": "<string>",
    "validity_days": 123,
    "is_available": "<string>",
    "quantity_available": 123,
    "quantity_redeemed": 123,
    "discount_percentage": "<string>",
    "discount_fixed_amount": "<string>",
    "maximum_discount_value": "<string>",
    "image_url": "<string>",
    "program_id": "<string>",
    "program_name": "<string>",
    "is_active": true,
    "already_redeemed": false,
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "settlement_budget": "<string>",
    "customer_split_pct": "<string>",
    "operator_split_pct": "<string>",
    "publisher_split_pct": "<string>",
    "sharer_split_pct": "<string>",
    "z_distributed_total": "<string>",
    "origin_type": "<string>",
    "budget_mode": "<string>",
    "campaign_status": "<string>",
    "campaign_operator_id": "<string>",
    "campaign_operator_name": "<string>"
  },
  "meta": {
    "cursor": "<string>",
    "has_next": true,
    "count": 123
  }
}

Authorizations

X-API-Key
string
header
required

Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.

Path Parameters

id
string
required

Unique identifier for this reward.

Response

data
object
required

Available reward in the loyalty program catalog with points cost and validity details.

meta
object
required

Cursor-based pagination metadata matching envelope middleware output.