Skip to main content
GET
List gift cards for buyer
This endpoint requires the gift-cards.read or embed scope.

Authorizations

Authorization
string
header
required

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

Query Parameters

buyer_id
string

Filters the results to only the items for which the buyer has an id that matches this value.

Example:

"8724fd24-5489-4a5d-90fd-0604df7d3b83"

buyer_external_identifier
string

Filters the results to only the items for which the buyer has an external_identifier that matches this value.

Example:

"user-12345"

Response

Returns a list of available gift cards for a buyer.

A list of gift cards in a short format including the latest balance.

items
A stored gift card (summary) · object[]

A list of stored gift cards.