UserAddresses
List all user addresses
Returns a list of your user addresses.
get/user_addresses
Query parameters
Consolidated page parameter (deepObject style). Originally: page[size], page[number]
Consolidated filter parameter (deepObject style). Originally: filter[customer_reference][eq], filter[customer_reference][contains], filter[street_address][contains]
sort'created_at' | 'first_name' | 'last_name' | 'business_name' | 'street_address'
Example:street_address
Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul>
<li> <code>street_address</code>: sorts the result by the <code>street_address</code> field in ascending order. </li> <li> <code>-street_address</code>: sorts the result by the <code>street_address</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.Response
Successful response
Example response
{
"data": [
{
"administrative_area": "TX",
"borough": "Guadalajara",
"business_name": "Toy-O'Kon",
"country_code": "US",
"created_at": "2018-02-02T22:25:27.521Z",
"customer_reference": "MY REF 001",
"extended_address": "14th Floor",
"first_name": "Alfred",
"id": "c3527e69-dc5a-4b3e-8f44-99d209f83c1d",
"last_name": "Foster",
"locality": "Austin",
"neighborhood": "Ciudad de los deportes",
"phone_number": "+12125559000",
"postal_code": "78701",
"record_type": "user_address",
"street_address": "600 Congress Avenue",
"updated_at": "2018-02-02T22:25:27.521Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}