Skip to main content

List all addresses

GET 
/account/addresses

Returns a list of your addresses.

Request ​

Query Parameters

    page integer

    Default value: 1

    Page number of results to load

    per_page integer

    Possible values: <= 1000

    Default value: 100

    Number of results per page

    include_non_address_book boolean

    Whether to include addresses not listed in your address book

Responses ​

200: Addresses response

Schema

  • Array [

    • id stringrequired
    first_name stringrequired

    Address first name

    last_name stringrequired

    Address last name

    business_name stringrequired

    Address business name

    phone_number string

    Address phone number

    street_address stringrequired

    Address first line

    extended_address stringrequired

    Address second line

    locality stringrequired

    Locality (city for US addresses)

    administrative_area stringrequired

    Administrative area (state for US addresses)

    postal_code stringrequired

    Postal code

    country_code stringrequired

    2-digit country code

    address_book booleanrequired

    Default value: true

    indicates if the address should be considered part of your 'address book' or not; addresses that are in your address book are shown by default when listing addresses, those not in your address book are not. They can still be shown by using the include_non_address_book filter when requesting addresses.

  • ]

401: Unauthorized

Request samples

curl -L 'https://api.telnyx.com/account/addresses' \
-H 'Accept: application/json'

Response samples

[
  {
    "id": "string",
    "first_name": "John",
    "last_name": "Smith",
    "business_name": "Telnyx",
    "phone_number": "+13125364300",
    "street_address": "311 W. Superior St.",
    "extended_address": "Suite 504",
    "locality": "CHICAGO",
    "administrative_area": "IL",
    "postal_code": "60654",
    "country_code": "US",
    "address_book": true
  }
]