v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Gift Cards

List gift cards

Returns a paginated list of gift cards.

🔒 Requires: gift_cards:read scope

get/gift_cards

Query parameters

beforestring

Pagination cursor for reverse-chronological traversal. Pass the ID of a gift card to retrieve the next page of gift cards created before it, ordered from newest to oldest.

page_sizeinteger

The maximum number of items to be returned in the response. Defaults to 1000. Maximum value is 1000.

card_numberstring

Find by gift card number.

status'ACTIVE' | 'INACTIVE' | 'REDEEMED' | 'VOIDED' | 'EXPIRED'

Filter by gift card status.

Response

The gift card list was successfully retrieved.