Skip to main content
GET
/
api
/
v2
/
rewards
List reward catalog
curl --request GET \
  --url https://api.zupy.com/api/v2/rewards/ \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "reward_type": "other",
      "points_required": 123,
      "monetary_value": "<string>",
      "validity_days": 123,
      "is_available": "<string>",
      "quantity_available": 123,
      "quantity_redeemed": 123,
      "discount_type": "none",
      "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"
    }
  ],
  "meta": {
    "cursor": "<string>",
    "has_next": true,
    "count": 123
  }
}

Authorizations

X-API-Key
string
header
required

API key for partner access via APISIX key-auth plugin

Query Parameters

cursor
string

Pagination cursor value from previous response.

customer_id
string

Customer KSUID — required when redeemable=true. Also annotates already_redeemed flag on each reward.

page_size
integer

Number of results to return per page.

redeemable
boolean

Filter to rewards the customer can redeem (has enough points and hasn't hit redemption limit). Requires customer_id.

Response

data
object[]
required
meta
object
required