Skip to main content
GET
Spree Admin SDK

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[name_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work. Sort by: automatic, created_at, id, name, permalink, position, products_count, sort_order, 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 name (partial, case-insensitive).

page
integer

Page number

limit
integer

Number of records per page

expand
string

Comma-separated associations to expand (e.g., rules, custom_fields, translations).

q
object

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

Response

200 - application/json

collections found

data
object[]
required
meta
object
required