# List a customer's addresses

```http
GET https://secure.yoprint.com/v1/api/store/{team_slug}/customer/{hash_id}/address
```

- API version: v1
- Operation ID: `v1_public_customer_address_index`
- Section: Customers › [Customer addresses](https://developer.yoprint.com/reference/customer-addresses.md)
- Web page: https://developer.yoprint.com/reference/customer-addresses/v1-customer-address-index/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Lists the customer's current billing and shipping addresses: the ones you can pick for new documents or edit. Not paged.

Send `mode=history` to list every billing and shipping address instead: deleted ones, old copies replaced by an edit (`superseded_by_address_id`) and addresses synced from Shopify. Each row says `used_by_active_profile` when a brand profile uses it.

## Permission

Any member of the team.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The customer's id (`id` from List customers or Create a customer). A hash id from an earlier answer; unique keys and document numbers (such as `PO0042`) don't work here. Example `EDhVUaC6jbLbed`.

## Query parameters

- `mode` (string, optional): `history` lists every billing and shipping address. Leave it out for current addresses only. One of: `"history"`. Example `history`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v1/api/store/your-team/customer/EDhVUaC6jbLbed/address' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `address1` (string | null, required)
    - `id` (string, required)
    - `is_current_source` (boolean, required): False for deleted, replaced, Shopify or redacted addresses. Only current addresses can be picked for new documents or edited.
    - `is_primary` (boolean, required)
    - `label` (string | null, required)
    - `revision_number` (integer, required): Goes up by one on every saved change. Send it back as `base_revision_number` when updating the address to protect against concurrent edits.
    - `role` (string, required): `billing` or `shipping` for customer addresses.
    - `trashed` (boolean, required)
    - `address2` (string | null, optional)
    - `address_family_id` (string | null, optional): Shared by an address and the copies made when it was edited after use.
    - `city` (string | null, optional)
    - `copied_from_address_id` (string | null, optional)
    - `country` (string | null, optional)
    - `country_code` (string | null, optional)
    - `customer_id` (string, optional): Customer addresses only: the customer's id.
    - `external_type` (string | null, optional): `shopify` for an address synced from Shopify.
    - `hold_stock` (boolean, optional): Company locations only; false for customer addresses.
    - `is_default_warehouse` (boolean, optional): Company locations only; false for customer addresses.
    - `is_external` (boolean, optional): True for an address synced from Shopify; such addresses are read-only.
    - `nexus` (boolean, optional): Company locations only; false for customer addresses.
    - `note` (string | null, optional)
    - `owner_id` (string | null, optional): The owner's id: for a customer address, the customer's id (the same as `customer_id`).
    - `owner_type` (string, optional): `customer` for customer addresses. One of: `"customer"`, `"team"`, `"unknown"`.
    - `postal_can_validate` (boolean, optional)
    - `postal_is_valid` (boolean, optional)
    - `postal_validated` (boolean, optional): True once YoPrint has checked the address with its address validator. `postal_can_validate` says whether it could be checked and `postal_is_valid` gives the result. Any edit resets it to false.
    - `postcode` (string | null, optional)
    - `source` (string, optional): `customer` for customer addresses. One of: `"customer"`, `"company_location"`, `"custom"`, `"unknown"`.
    - `state` (string | null, optional)
    - `state_code` (string | null, optional)
    - `superseded_at` (string (date-time) | null, optional)
    - `superseded_by_address_id` (string | null, optional): Set on an old copy: the address that replaced it.
    - `used_by_active_profile` (boolean, optional): True when a brand profile uses it as Ship From. Sent on lists, reads, updates and customer answers; not on create or set-primary.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": [
    {
      "address1": "100 Example Street",
      "address2": "Suite 200",
      "address_family_id": null,
      "city": "Springfield",
      "copied_from_address_id": null,
      "country": "United States",
      "country_code": "US",
      "customer_id": "V4keXwwxMQyXw7",
      "external_type": null,
      "hold_stock": false,
      "id": "KKhhlVobndGXEj",
      "is_current_source": true,
      "is_default_warehouse": false,
      "is_external": false,
      "is_primary": true,
      "label": "Head office",
      "nexus": false,
      "note": null,
      "owner_id": "V4keXwwxMQyXw7",
      "owner_type": "customer",
      "postal_can_validate": false,
      "postal_is_valid": false,
      "postal_validated": false,
      "postcode": "62701",
      "revision_number": 1,
      "role": "billing",
      "source": "customer",
      "state": "Illinois",
      "state_code": "IL",
      "superseded_at": null,
      "superseded_by_address_id": null,
      "trashed": false,
      "used_by_active_profile": true
    },
    {
      "address1": "100 Example Street",
      "address2": "Dock 4",
      "address_family_id": null,
      "city": "Springfield",
      "copied_from_address_id": null,
      "country": "United States",
      "country_code": "US",
      "customer_id": "V4keXwwxMQyXw7",
      "external_type": null,
      "hold_stock": false,
      "id": "swtHxyIfOvF62K",
      "is_current_source": true,
      "is_default_warehouse": false,
      "is_external": false,
      "is_primary": true,
      "label": "Warehouse",
      "nexus": false,
      "note": null,
      "owner_id": "V4keXwwxMQyXw7",
      "owner_type": "customer",
      "postal_can_validate": false,
      "postal_is_valid": false,
      "postal_validated": false,
      "postcode": "62701",
      "revision_number": 1,
      "role": "shipping",
      "source": "customer",
      "state": "Illinois",
      "state_code": "IL",
      "superseded_at": null,
      "superseded_by_address_id": null,
      "trashed": false,
      "used_by_active_profile": false
    }
  ],
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.

## Notes

- The current list leaves out addresses synced from Shopify. Use `mode=history` to see them.

## Related

- [Add an address to a customer](https://developer.yoprint.com/reference/customer-addresses/v1-customer-address-store.md): `POST /v1/api/store/{team_slug}/customer/{hash_id}/address`
- [Update a customer address](https://developer.yoprint.com/reference/customer-addresses/v1-customer-address-update.md): `PUT /v1/api/store/{team_slug}/customer/{hash_id}/address/{id}`