---
title: "Searches customer addresses based on search criteria"
method: GET
path: "/api/v1/customers/{customerId}/addresses/search"
tags: ["CustomerAddresses"]
---

# Searches customer addresses based on search criteria

`GET /api/v1/customers/{customerId}/addresses/search`

## Request

- Base URL: `https://api.ekm.net`
- URL: `https://api.ekm.net/api/v1/customers/{customerId}/addresses/search`
- Auth: none required

## Path parameters

- `customerId` integer, required: The Customer Id

## Query parameters

- `page` integer
- `limit` integer
- `query` string, required
- `orderby` string

## Response `200`

A page of customer adresses based on search criteria

- TempestResponseListV1CustomerAddress
  - `meta` object, nullable
  - `links` TempestLink[], nullable
    - `rel` string, nullable
    - `href` string, nullable
  - `validation_result` TempestValidationError[], nullable
    - `member_names` string[], nullable
    - `error_message` string, nullable
  - `errors` object, nullable
  - `data` V1CustomerAddress[], nullable
    - `id` integer
    - `created_date` string, date-time, nullable
    - `modified_date` string, date-time, nullable
    - `customer_id` integer
    - `is_preferred_billing_address` boolean
    - `is_preferred_shipping_address` boolean
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `company` string, nullable
    - `address` string, required
    - `address2` string, nullable
    - `town` string, required
    - `county` string, nullable
    - `country` string, required
    - `friendly_country` string, nullable
    - `post_code` string, required
    - `telephone` string, nullable
    - `fax` string, nullable

## Other responses

- `400`: Invalid Request
- `401`: Unauthorized
- `403`: Forbidden

---

[API](https://skmtc.dev/ekm/apis/ekm-partner-api.md) - [All operations](https://skmtc.dev/ekm/apis/ekm-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ekm/apis/ekm-partner-api/revisions/c22f05a7b0dc?raw)