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.

         For a full sync, page with `Cursor` instead of `PageNumber`: send `Cursor=start`, then pass each response's `NextCursor` back until it is null. Cursor pages are ordered oldest-created first, cost the same however deep you go, and don't shift when cards are updated mid-sync. `TotalCount` is -1 in cursor mode. `PageNumber` paging still works, but every page recounts the whole result set and deep pages get slower.
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.

string

Gift card list only. Opaque paging cursor for full syncs. Send Cursor=start for the first page, then
pass each response's NextCursor back until it comes back null. In cursor mode cards are ordered by when
they were created (oldest first) rather than by last update, PageNumber is ignored, every page is as fast
as the first, and TotalCount isn't calculated (it's returned as -1). PageSize, Since and
IncludeAll still apply.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

NextCursor in cursor mode).

Cursor is not one this endpoint returned.

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