Skip to main content
GET
List reward catalog

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.

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