Skip to main content

List all user addresses

GET 
/user_addresses

Returns a list of your user addresses.

Request ​

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    filter[customer_reference][eq] string

    Filter user addresses via the customer reference set. Matching is not case-sensitive.

    filter[customer_reference][contains] string

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

    filter[street_address][contains] string

    Default value: null

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

    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

Schema

    data

    object[]

  • Array [

    • id uuid

    Uniquely identifies the user address.

    record_type string

    Identifies the type of the resource.

    customer_reference customer_reference (string)

    A customer reference string for customer look ups.

    first_name first_name (string)

    The first name associated with the user address.

    last_name last_name (string)

    The last name associated with the user address.

    business_name business_name (string)

    The business name associated with the user address.

    phone_number phone_number (string)

    The phone number associated with the user address.

    street_address street_address (string)

    The primary street address information about the user address.

    extended_address extended_address (string)

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

    locality locality (string)

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

    administrative_area administrative_area (string)

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

    neighborhood neighborhood (string)

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

    borough borough (string)

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

    postal_code postal_code (string)

    The postal code of the user address.

    country_code country_code (string)

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

    created_at string

    ISO 8601 formatted date indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date indicating when the resource was updated.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

400: Bad request

401: Unauthorized

404: Resource not found

Request samples

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

Response samples

{
  "data": [
    {
      "id": "c3527e69-dc5a-4b3e-8f44-99d209f83c1d",
      "record_type": "user_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",
      "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
  }
}