Skip to main content
GET
List issued coupons

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.

page_size
integer

Number of results to return per page.

status
string

Filter by status: active | used | expired | cancelled.

customer_id
string

Restrict to one customer (LoyaltyUser id).

origin_type
enum<string>

Coupon provenance: loyalty_reward | marketing.

Available options:
loyalty_reward,
marketing
reward_id
string

Restrict to coupons issued from one reward.

code
string

Exact coupon_code lookup (case-insensitive).

Response

data
object[]
required
meta
object
required