Skip to main content
GET
/
cash_vouchers
Cash Voucher List
curl --request GET \
  --url https://api.atlas.kitchen/admin/v1/cash_vouchers \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Merchant-Id: <api-key>'
{
  "object": "cash_voucher",
  "items": [
    {
      "id": 123,
      "label": "External gift voucher",
      "description": "Issued by external gift-card platform",
      "code": "EXT-ABC123",
      "value": 5000,
      "expires_after": "2026-12-31",
      "unique": true,
      "status": "active",
      "redemptions_count": 0,
      "created_at": 1781615664,
      "updated_at": 1781615664
    }
  ]
}

Authorizations

X-Api-Key
string
header
required

Your API key provided during onboarding. Example c2fb5ae6ea99c37d...

X-Merchant-Id
string
header
required

Your numeric merchant ID. Example 1

Query Parameters

status
enum<string>

Filter by voucher status.

Available options:
active,
expired,
redeemed
code
string

Partial, case-insensitive voucher code search.

Response

Cash vouchers

object
string
Example:

"cash_voucher"

items
object[]