Skip to main content
GET
Spree Admin SDK

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[provider_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[payout_id_eq]. The same predicates apply.
Sort by: amount, created_at, currency, id, kind, order_id, payout_id, provider, reference, seller_id, status, 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

Query Parameters

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

page
integer

Page number

limit
integer

Records per page (max 100)

q
object

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

Response

200 - application/json

transfers listed

data
object[]
required
meta
object
required