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.
Prefix an associated record’s attribute with the association, as in q[children_id_eq]. The same predicates apply.
Sort by: created_at, id, kind, name, parent_id, po_number_required, 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 name (partial, case-insensitive).

q
object

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

Response

200 - application/json

companies found