Skip to main content
GET
/
addresses
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const addresses = await client.addresses.list();

console.log(addresses.data);
{
  "data": [
    {
      "id": "1293384261075731499",
      "record_type": "address",
      "customer_reference": "MY REF 001",
      "first_name": "Alfred",
      "last_name": "Foster",
      "business_name": "Toy-O'Kon",
      "phone_number": "+12125559000",
      "street_address": "600 Congress Avenue",
      "extended_address": "14th Floor",
      "locality": "Austin",
      "administrative_area": "TX",
      "neighborhood": "Ciudad de los deportes",
      "borough": "Guadalajara",
      "postal_code": "78701",
      "country_code": "US",
      "address_book": false,
      "validate_address": true,
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

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[number], page[size]

​
filter
object

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
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 <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.
Available options:
created_at,
first_name,
last_name,
business_name,
street_address
Example:

"street_address"

Response

Successful response

​
data
Address · object[]
​
meta
object