Skip to main content
GET
Spree SDK

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[code_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work. Sort by: code, created_at, created_by_id, currency, customer_id, expires_at, gift_card_batch_id, id, state, status, updated_at. Prefix a field with - to sort descending.

Authorizations

x-spree-api-key
string
header
required

Publishable API key for store access

Authorization
string
header
required

JWT token for authenticated customers

Headers

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

Query Parameters

Matches any of code (partial, case-insensitive).

q[active]
boolean

Set to true to apply active.

q[expired]
boolean

Set to true to apply expired.

q[partially_redeemed]
boolean

Set to true to apply partially_redeemed.

q[redeemed]
boolean

Set to true to apply redeemed.

page
integer
limit
integer
fields
string

Comma-separated list of fields to include (e.g., name,slug,price). id is always included.

q
object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

Response

gift cards found

data
object[]
meta
object