Skip to main content
GET
Spree Admin SDK

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[key_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work. Sort by: created_at, field_type, id, key, label, namespace, resource_type, searchable, sortable, storefront_visible, 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 namespace, key, and label (partial, case-insensitive).

expand
string

Comma-separated associations to expand. Use dot notation for nested expand (max 4 levels).

fields
string

Comma-separated list of fields to include (e.g., key,label,field_type). id is always included.

q
object

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

Response

200 - application/json

definitions returned