Skip to main content
GET
List Gift Cards
Search and retrieve a paginated list of gift cards. Use filters to narrow results by SKU, issue date, or status flags.
string
required
Your API key
string
Filter by SKU
string
Filter by issue date (start). Format: yyyy-MM-ddTHH:mm:ss.fffZ
string
Filter by issue date (end). Format: yyyy-MM-ddTHH:mm:ss.fffZ
boolean
Include cancelled cards. Default: false
boolean
Include fully redeemed cards. Default: false
boolean
Include expired cards. Default: false
integer
Number of records to return
integer
Zero-based offset for pagination
Response is a paginated result with from, to, length, and items (array of GiftCard). GiftCard fields Example 200 Response

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

API Key authentication header

Query Parameters

Sku
string

The Gift Card Sku.

IssueDateUtcStart
string<date-time>

Filter on Gift Card Issued Start Date (UTC).

IssueDateUtcEnd
string<date-time>

Filter on Gift Card Issued End Date (UTC).

IncludeCancelled
boolean

Include Cancelled cards in the range. Default true.

IncludeRedeemed
boolean

Include Redeemed cards in the range. Default true.

IncludeExpired
boolean

Include Expired cards in the range. Default true.

Limit
integer

Max number of records to return, default is 100, max is 100.

Required range: 1 <= x <= 100
StartIndex
integer<int32>

Number of matching records to skip before returning the matches, default is 0.

Response

OK

from
integer<int64>
to
integer<int64>
length
integer<int64>
items
object[] | null