Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

filter
object

Consolidated filter parameter (deepObject style). Originally: filter[customer_reference][eq], filter[customer_reference][contains], filter[street_address][contains]

sort
enum<string>
default:created_at

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

That is:

  • street_address: sorts the result by the street_address field in ascending order.
  • -street_address: sorts the result by the street_address field in descending order.

If not given, results are sorted by created_at in descending order.
Available options:
created_at,
first_name,
last_name,
business_name,
street_address
Example:

"street_address"

Response

Successful response

data
UserAddress · object[]
meta
object