Skip to main content
GET
List gift cards.

Authorizations

x-api-key
string
header
required

Your workspace API key. It both authenticates the caller and selects the workspace.

Query Parameters

q
string

Case-insensitive substring match on the gift-card code.

status
string

Filter by status: pending, active, exhausted, expired or cancelled.

per_page
integer

Items per page (alias: limit). Default 25, max 100.

Response

A paginated list.

A paginated collection. per_page defaults to 25 and is capped at 100.

data
object[]
meta
object