Addresses V1

Address operations

List all addresses

Returns a list of your addresses.

Request
query Parameters
page
integer
Default: 1

Page number of results to load

per_page
integer <= 1000
Default: 100

Number of results per page

include_non_address_book
boolean
Default: false

Whether to include addresses not listed in your address book

Responses
200

Addresses response

Response Schema: application/json
Array
id
required
string
first_name
required
string

Address first name

last_name
required
string

Address last name

business_name
required
string

Address business name

phone_number
string

Address phone number

street_address
required
string

Address first line

extended_address
required
string

Address second line

locality
required
string

Locality (city for US addresses)

administrative_area
required
string

Administrative area (state for US addresses)

postal_code
required
string

Postal code

country_code
required
string

2-digit country code

address_book
required
boolean
Default: 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

get/account/addresses
Request samples 
Response samples 
application/json
[
  • {
    • "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
    }
]
Create an address
Creates a new address object.


Request 
Request Body schema: application/json
required
Address to add


first_name
required
string
Address first name


 
last_name
required
string
Address last name


 
business_name
string
Address business name


 
phone_number
required
string
Address phone number


 
street_address
required
string
Address first line


 
extended_address
string
Address second line


 
locality
required
string
Locality (city for US addresses)


 
administrative_area
string
Administrative area (state for US addresses)


 
postal_code
string
Postal code


 
country_code
required
string
2-digit country code


 
address_book
boolean
 Default:  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.


 
Responses 
200
Address created response


Response Schema: application/json
id
required
string
 
first_name
required
string
Address first name


 
last_name
required
string
Address last name


 
business_name
required
string
Address business name


 
phone_number
string
Address phone number


 
street_address
required
string
Address first line


 
extended_address
required
string
Address second line


 
locality
required
string
Locality (city for US addresses)


 
administrative_area
required
string
Administrative area (state for US addresses)


 
postal_code
required
string
Postal code


 
country_code
required
string
2-digit country code


 
address_book
required
boolean
 Default:  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.


 
400
Bad request


401
Unauthorized


post/account/addresses
Request samples 
application/json
{
  • "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
}
Response samples 
application/json
{
  • "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
}
Retrieve an address
Retrieves the details of an existing address.


Request 
path Parameters
id
required
string
ID of Address to retrieve


 
Responses 
200
Address record response


Response Schema: application/json
id
required
string
 
first_name
required
string
Address first name


 
last_name
required
string
Address last name


 
business_name
required
string
Address business name


 
phone_number
string
Address phone number


 
street_address
required
string
Address first line


 
extended_address
required
string
Address second line


 
locality
required
string
Locality (city for US addresses)


 
administrative_area
required
string
Administrative area (state for US addresses)


 
postal_code
required
string
Postal code


 
country_code
required
string
2-digit country code


 
address_book
required
boolean
 Default:  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


404
Resource not found


get/account/addresses/{id}
Request samples 
Response samples 
application/json
{
  • "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
}
Delete an address
Permanently deletes an address.


Request 
path Parameters
id
required
string
ID of Address to delete


 
Responses 
200
Address deleted response


Response Schema: application/json
id
required
string
 
first_name
required
string
Address first name


 
last_name
required
string
Address last name


 
business_name
required
string
Address business name


 
phone_number
string
Address phone number


 
street_address
required
string
Address first line


 
extended_address
required
string
Address second line


 
locality
required
string
Locality (city for US addresses)


 
administrative_area
required
string
Administrative area (state for US addresses)


 
postal_code
required
string
Postal code


 
country_code
required
string
2-digit country code


 
address_book
required
boolean
 Default:  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.


 
404
Resource not found


delete/account/addresses/{id}
Request samples 
Response samples 
application/json
{
  • "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
}