Telnyx

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

page[number]

integer

default:1

The page number to load

Required range: x >= 1

page[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

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

filter[street_address]

object

Show child attributes

filter[street_address][contains]

string

If present, addresses with street_address containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

filter[address_book]

object

Show child attributes

filter[address_book][eq]

string

If present, only returns results with the address_book flag equal to the given value.

filter[customer_reference]

If present, addresses with customer_reference containing the given value will be returned. Matching is not case-sensitive.

filter[used_as_emergency]

string

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.

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

Successful response

data

Address · object[]

Show child attributes

data.id

string<int64>

Uniquely identifies the address.

Example:

"1293384261075731499"

data.record_type

string

Identifies the type of the resource.

Example:

"address"

data.customer_reference

string

A customer reference string for customer look ups.

Example:

"MY REF 001"

data.first_name

string

The first name associated with the address. An address must have either a first last name or a business name.

Example:

"Alfred"

data.last_name

string

The last name associated with the address. An address must have either a first last name or a business name.

Example:

"Foster"

data.business_name

string

The business name associated with the address. An address must have either a first last name or a business name.

Example:

"Toy-O'Kon"

data.phone_number

string

The phone number associated with the address.

Example:

"+12125559000"

data.street_address

string

The primary street address information about the address.

Example:

"600 Congress Avenue"

data.extended_address

string

Additional street address information about the address such as, but not limited to, unit number or apartment number.

Example:

"14th Floor"

data.locality

string

The locality of the address. For US addresses, this corresponds to the city of the address.

Example:

"Austin"

data.administrative_area

string

The locality of the address. For US addresses, this corresponds to the state of the address.

Example:

"TX"

data.neighborhood

string

The neighborhood of the address. This field is not used for addresses in the US but is used for some international addresses.

Example:

"Ciudad de los deportes"

data.borough

string

The borough of the address. This field is not used for addresses in the US but is used for some international addresses.

Example:

"Guadalajara"

data.postal_code

string

The postal code of the address.

Example:

"78701"

data.country_code

string

The two-character (ISO 3166-1 alpha-2) country code of the address.

Example:

"US"

data.address_book

boolean

default:true

Indicates whether or not the address should be considered part of your list of addresses that appear for regular use.

Example:

false

data.validate_address

boolean

default:true

Indicates whether or not the address should be validated for emergency use upon creation or not. This should be left with the default value of true unless you have used the /addresses/actions/validate endpoint to validate the address separately prior to creation. If an address is not validated for emergency use upon creation and it is not valid, it will not be able to be used for emergency services.

Example:

true

data.created_at

string

ISO 8601 formatted date indicating when the resource was created.

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

ISO 8601 formatted date indicating when the resource was updated.

Example:

"2018-02-02T22:25:27.521Z"

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List all addresses

Authorizations

Query Parameters

Response