---
title: "List addresses"
method: GET
path: "/api/v2/customers/{customerId}/addresses"
tags: ["Customer Address"]
---

# List addresses

`GET /api/v2/customers/{customerId}/addresses`

Fetches a list of addresses that belong to specified customer. The list includes the main address (type=masterdata), billing address (type=billingaddress) and all delivery addresses (type=deliveryaddress).

## Path parameters

- `customerId` string, required — Resource identifier.

## Query parameters

- `filter` object[]
  - `key` 'type'
  - `op` 'equals' | 'notEquals' | 'in' | 'notIn'
  - `value` 'masterdata' | 'billingaddress' | 'deliveryaddress'
- `page` object
  - `number` string, required — Page number should be an integer greater than or equal to 1
  - `size` string, required — Page size should usually be an integer between 10 and 50.

## Response `200`

List of customer's addresses

- object
  - `data` object[], required
    - `id` string — Resource identifier. Can be 'masterdata', 'billingaddress', or a numeric id.
    - `type` 'masterdata' | 'billingaddress' | 'deliveryaddress' — The type of the address. Can be 'masterdata', 'billingaddress', or 'deliveryaddress'.
    - `name` string — The recipient's name.
    - `street` string — Street and house number.
    - `addressSupplement` string, nullable — Optional second address line.
    - `department` string, nullable — Department.
    - `subDepartment` string, nullable — Sub-department.
    - `zip` string — Postal code.
    - `city` string — City.
    - `country` string — Country code in ISO 3166-1 alpha-2 format.
    - `state` string — State code in ISO 3166-2 format.
  - `extra` object, required
    - `totalCount` integer, required — the total count of all items
    - `page` object, required — The pagination object containing the current page number and size
      - `number` integer, required — The current page number
      - `size` integer, required — The size of the pages
  - `links` object, required — Paths for list traversal and to access related resources.
    - `self` string — The URI of the current page.
    - `next` string, nullable — The path of the next page. If value is null, this is the last page.
    - `prev` string, nullable — The path of the previous page. If value is null, this is the first page.
    - `customer` string — The path of the customer resource.

## Other responses

- `400` — IETF RFC 9457 Problem API compliant response
- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `404` — Resource was not found or not enough access privileges
- `406` — Requested resource representation does not exist.

---

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