Skip to main content
GET
Spree Admin SDK

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Bearer token for admin authentication

Query Parameters

page
integer

Page number

limit
integer

Number of records per page

q[code_cont]
string

Filter by gift card code (contains)

q[state_eq]
string

Filter by status (active, redeemed, partially_redeemed, canceled)

sort
string

Sort by field. Prefix with - for descending (e.g., -created_at).

fields
string

Comma-separated list of fields to include. id is always included.

Response

gift cards found

data
object[]
required
meta
object
required