<- Gift Cards API

Gift Cards API

All versions ->

List gift cards

GET

 /v2/gift-cards

Lists all gift cards.

You can specify optional filters to retrieve a subset of the gift cards. Results are sorted by created_at in ascending order.

Permissions:GIFTCARDS_READ

Guide

List gift cards

Try in API Explorer
Link to section

Query parameters

Example code

Link to section

type

string

If a type is provided, the endpoint returns gift cards of the specified type. Otherwise, the endpoint returns gift cards of all types.

Link to section

state

string

If a state is provided, the endpoint returns the gift cards in the specified state. Otherwise, the endpoint returns the gift cards of all states.

Link to section

limit

integer(32-bit)

If a limit is provided, the endpoint returns only the specified number of results per page. The maximum value is 200. The default value is 30. For more information, see Pagination.

Link to section

cursor

string

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see Pagination.

Link to section

customer_id

string

If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

gift_cards

The requested gift cards or an empty object if none are found.

Link to section

cursor

string

When a response is truncated, it includes a cursor that you can use in a subsequent request to retrieve the next set of gift cards. If a cursor is not present, this is the final response. For more information, see Pagination.