---
title: "List all user addresses"
method: GET
path: "/user_addresses"
tags: ["UserAddresses"]
---

# List all user addresses

`GET /user_addresses`

Returns a list of your user addresses.

## Query parameters

- `page` object
  - `size` integer — The size of the page
  - `number` integer — The page number to load
- `filter` object
  - `customer_reference` object — Filter user addresses via the customer reference. Supports both exact matching (eq) and partial matching (contains). Matching is not case-sensitive.
    - `eq` string — Filter user addresses via exact customer reference match. Matching is not case-sensitive.
    - `contains` string — If present, user addresses with <code>customer_reference</code> containing the given value will be returned. Matching is not case-sensitive.
  - `street_address` object — Filter user addresses via street address. Supports partial matching (contains). Matching is not case-sensitive.
    - `contains` string — If present, user addresses with <code>street_address</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
- `sort` 'created_at' | 'first_name' | 'last_name' | 'business_name' | 'street_address'

## Response `200`

Successful response

- object
  - `data` UserAddressesUserAddress[]
    - `id` string, uuid — Uniquely identifies the user address.
    - `record_type` string — Identifies the type of the resource.
    - `customer_reference` string — A customer reference string for customer look ups.
    - `first_name` string — The first name associated with the user address.
    - `last_name` string — The last name associated with the user address.
    - `business_name` string — The business name associated with the user address.
    - `phone_number` string — The phone number associated with the user address.
    - `street_address` string — The primary street address information about the user address.
    - `extended_address` string — Additional street address information about the user address such as, but not limited to, unit number or apartment number.
    - `locality` string — The locality of the user address. For US addresses, this corresponds to the city of the address.
    - `administrative_area` string — The locality of the user address. For US addresses, this corresponds to the state of the address.
    - `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` 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` string — The postal code of the user address.
    - `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` PaginationMeta
    - `total_pages` integer
    - `total_results` integer
    - `page_number` integer
    - `page_size` integer

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Resource not found

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/versions/8f5f4e537994/schema)