Skip to main content

Retrieve a user address

GET 
/user_addresses/:id

Retrieves the details of an existing user address.

Request ​

Path Parameters

    id stringrequired

    user address ID

Responses ​

200: Successful response

Schema

    data

    object

    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.

401: Unauthorized

404: Resource not found

422: Bad request

Request samples

curl -L 'https://api.telnyx.com/v2/user_addresses/:id' \
-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"
  }
}