---
title: "List Addresses"
method: GET
path: "/addresses"
tags: ["Addresses"]
---

# List Addresses

`GET /addresses`

## Query parameters

- `country` string — ISO 3166-1 Alpha-2 or Alpha-3 country code.
- `business_id` string, uuid
- `is_registered_agent` boolean — Whether the address uses a registered agent or not
- `customer_id` string, uuid
- `page_token` string — Optional pagination token to be provided to retrieve subsequent pages, returned from previous get
- `is_active` boolean — Whether the address is active or not
- `limit` integer — Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.
- `address_type` string[]

## Response `200`

List of addresses

- AddressesList
  - `addresses` AddressResponse[], required — Array of Addresses
    - `business_id` string, uuid — The identifier for the business customer associated with address.
    - `creation_date` string, date-time, required — Date and time when the address was created.
    - `customer_id` string, uuid — The identifier for the personal customer associated with address.
    - `is_active` boolean, required — Whether the address is active or not
    - `last_updated_time` string, date-time, required
    - `address_line_1` string, required — Street address line 1
    - `address_line_2` string — Street address line 2
    - `address_type` 'BILLING' | 'LEGAL' | 'OPERATING' | 'OTHER' | 'SHIPPING' — Specifies the address type.
    - `city` string — City
    - `country_code` string, required — ISO-3166-1 Alpha-2 country code
    - `id` string, uuid, required — The unique identifier for this resource.
    - `is_registered_agent` boolean — Indicates whether an address is a registered agent. Omitted if the address is not a registered agent.
    - `nickname` string — A nickname for the address. This is used to identify the address in the UI.
    - `postal_code` string — Postal code. For US, formats of 12345 or 12345-1234 are accepted. For CA, formats of A1A 1A1 or A1A1A1 (regardless of case) are accepted, and will be converted to A1A 1A1 format.
    - `state` string — State, region, province, or prefecture. This is the ISO-3166-2 subdivision code, excluding the country prefix. For example, TX for Texas USA or TAM for Tamaulipas Mexico. Its length varies by country, e.g. 2 characters for US, 3 for MX.
  - `next_page_token` string — If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden error
- `500` — Internal server error

---

[API](https://skmtc.net/synctera/apis/synctera-api.md) · [All operations](https://skmtc.net/synctera/apis/synctera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/synctera/synctera-api/revisions/b0d812e6cdd0/schema)