Skip to main content
GET
/
api
/
v2
/
coupons
/
issued
List issued coupons
curl --request GET \
  --url https://api.zupy.com/api/v2/coupons/issued/ \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "coupon_code": "<string>",
      "reward_name": "<string>",
      "reward_id": "<string>",
      "customer_id": "<string>",
      "customer_name": "<string>",
      "status_display": "<string>",
      "points_spent": 123,
      "redemption_date": "2023-11-07T05:31:56Z",
      "valid_until": "2023-11-07T05:31:56Z",
      "remaining_usages": 123,
      "total_usages_allowed": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "usage_date": "2023-11-07T05:31:56Z",
      "origin_type": "<string>"
    }
  ],
  "meta": {
    "cursor": "<string>",
    "has_next": true,
    "count": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.zupy.com/llms.txt

Use this file to discover all available pages before exploring further.

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