List gift cards.

Excludes store credit accounts. Ordered by most recently updated first. Use Since for incremental sync — it matches cards issued strictly after the timestamp. Voided, expired and fully-redeemed cards are always returned; pass IncludeAll=true to additionally include soft-deleted cards. Note PageNumber is zero-based and defaults to 1, so a request that doesn't set it starts at the second page.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

Page number (default 1). The convention differs by endpoint, so check the endpoint's own description: the gift card
list counts from 0 and skips PageSize × PageNumber records, so the default of 1 starts at the second page,
while the coupon list counts from 1 as you'd expect.

int32

Items per page (default 10, max 50).

date-time

Incremental-sync cursor, as a UTC timestamp. Like PageNumber, the exact meaning is per endpoint: the gift
card list returns cards issued strictly after it, the coupon list returns coupons created at or after it.

string

Reserved. Currently ignored — results are always ordered by most recently updated first.

string

Reserved. Currently ignored — results are always ordered by most recently updated first.

boolean

Include soft-deleted gift cards in the response. Defaults to false. Voided, expired and fully-redeemed cards are already returned regardless of this flag.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

x-api-key.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json