List all addresses

Returns a list of your addresses.

GET /addresses

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const address of client.addresses.list()) {
  console.log(address.id);
}

200

{
  "data": [
    {
      "id": "1293384261075731499",
      "record_type": "address",
      "customer_reference": "MY REF 001",
      "first_name": "Alfred",
      "last_name": "Foster",
      "business_name": "Toy-O'Kon",
      "phone_number": "[phone]",
      "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]

Show child attributes

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]

Show child attributes

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

200

application/json

Successful response

data · Address · object[]

Show child attributes

meta · object

Show child attributes