Skip to main content
GET
List gift cards

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

barcode
string

Only return the gift card carrying this barcode, on the card itself or a card merged into it. Matched exactly.

Maximum string length: 255
ending_before
string

Return records that precede the record with this ID, in list order.

limit
integer
default:20

Maximum number of records to return.

Required range: 1 <= x <= 100
magstripe_account_number
string

Only return the gift card carrying this magnetic-stripe account number, on the card itself or a card merged into it. Matched exactly.

Maximum string length: 255
owner_shopper_id
string[]

Only return gift cards owned by this shopper. Accepts a TypeID or a UUID. Repeat to match any of up to 20 values.

starting_after
string

Return records that follow the record with this ID, in list order.

status
enum<string>[]

Whether the gift card is active and can be used, or has been deactivated. Repeat to match any of up to 20 values.

Available options:
active,
deactivated

Response

data
object[]
required
has_more
boolean
required

Whether more records follow this page.