Spree Admin SDK
List companies
Returns the business customers of the current store.
Required scope: read_customers (for API-key authentication).
GET
Spree Admin SDK
Filters
Filter withq[<attribute>_<predicate>]=value, for example q[name_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.
Filters through associations
Filters through associations
Prefix an associated record’s attribute with the association, as in
q[children_id_eq]. The same predicates apply.created_at, id, kind, name, parent_id, po_number_required, updated_at. Prefix a field with - to sort descending.Authorizations
Secret API key for admin access
JWT token for admin user authentication
Query Parameters
Matches any of name (partial, case-insensitive).
Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.
Response
200 - application/json
companies found

