Skip to main content

List all addresses

GET 
/addresses

Returns a list of your addresses.

Request

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 string

    Possible values: [created_at, first_name, last_name, business_name, street_address]

    Default value: 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.

Responses

200: Successful response

400: Bad request

401: Unauthorized

404: Resource not found

Request samples


curl -L 'https://api.telnyx.com/v2/addresses' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples


{
"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
}
}