Skip to main content
GET
Spree Admin SDK

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[memo_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.
Prefix an associated record’s attribute with the association, as in q[customer_id_eq]. The same predicates apply.
Sort by: amount, created_at, created_by_id, currency, customer_id, id, memo, updated_at. Prefix a field with - to sort descending.

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

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

q[from_gift_card]
boolean

Set to true to apply from_gift_card.

q[outstanding]
boolean

Set to true to apply outstanding.

page
integer

Page number

limit
integer

Number of records per page

q
object

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

expand
string

Comma-separated associations to expand (customer, created_by).

sort
string

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

Response

store credits found

data
object[]
required
meta
object
required