Skip to main content
GET
Spree Admin SDK

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[address1_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work. Sort by: address1, address2, city, company, country_code, created_at, first_name, id, last_name, phone, postal_code, state_code, 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

Path Parameters

company_id
string
required

Query Parameters

q
object

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

Response

200 - application/json

addresses found

data
object[]
required
meta
object
required