List Vouchers

Retrieve a paginated list of vouchers

Authorization · string · required

Bearer token with marketing:read scope

Query parameters

status · string

Filter by status: pending, active, depleted, expired, cancelled, suspended

type · string

Filter by type: gift_card, store_credit, loyalty_reward, compensation, referral

customer_id · string

Filter by customer ID

limit · integer · default: "50"

Number of results per page (max 100)

offset · integer · default: "0"

Number of results to skip

Response

data.vouchers · array

Array of voucher objects

data.meta.total · integer

Total number of vouchers matching the filter

data.meta.limit · integer

Number of results per page

data.meta.offset · integer

Number of results skipped

Request

curl -X GET "https://api.voyantcloud.com/v1/vouchers?status=active&type=gift_card" \
  -H "Authorization: Bearer $API_KEY"

Response

{
  "data": {
    "vouchers": [
      {
        "id": "voucher_abc123",
        "code": "GC1A2B3C4D",
        "type": "gift_card",
        "status": "active",
        "customerId": null,
        "initialBalanceMinor": 10000,
        "currentBalanceMinor": 7500,
        "currency": "EUR",
        "expiresAt": "2025-12-31T23:59:59Z",
        "isTransferable": true,
        "lastUsedAt": "2024-07-15T10:30:00Z",
        "createdAt": "2024-01-15T09:00:00Z"
      }
    ],
    "meta": {
      "total": 1,
      "limit": 50,
      "offset": 0
    }
  }
}