v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Addresses

List all addresses

Returns a list of your addresses.

get/addresses

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

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

used_as_emergencystring

If set as 'true', only addresses used as the emergency address for at least one active phone-number will be returned. When set to 'false', the opposite happens: only addresses not used as the emergency address from phone-numbers will be returned.

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

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": "1293384261075731499",
      "last_name": "Foster",
      "locality": "Austin",
      "neighborhood": "Ciudad de los deportes",
      "phone_number": "+12125559000",
      "postal_code": "78701",
      "record_type": "address",
      "street_address": "600 Congress Avenue",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "validate_address": true
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}