---
title: "Gets a list of customers"
method: POST
path: "/api/v{version}/customers/search"
tags: ["customers"]
---

# Gets a list of customers

`POST /api/v{version}/customers/search`

Gets a list of customers with pagination and filtering support

## Path parameters

- `version` string, required

## Headers

- `X-Tenant` string, required

## Request body

- SearchCustomersRequest
  - `advancedSearch` Search
    - `fields` string[], nullable
    - `keyword` string, nullable
  - `keyword` string, nullable
  - `advancedFilter` Filter
    - `logic` string, nullable
    - `filters` Filter[], nullable
    - `field` string, nullable
    - `operator` string, nullable
    - `value` unknown
  - `pageSize` integer
  - `pageNumber` integer
  - `orderBy` string[], nullable
  - `includeAllAddresses` boolean
  - `includePrimaryAddressOnly` boolean

## Response `200`

OK

- PagedListCustomerResponse
  - `items` CustomerResponse[], nullable
    - `id` string, uuid
    - `name` string, nullable
    - `phone` PhoneDto
      - `number1` string, nullable
      - `number2` string, nullable
      - `number3` string, nullable
    - `dateOfBirth` string, date-time, nullable
    - `instruction` string, nullable
    - `timeSlot` string, nullable
    - `deliveryPreference` string, nullable
    - `companyId` string, nullable
    - `companyContactPerson` string, nullable
    - `addresses` AddressResponse[], nullable
      - `id` string, uuid
      - `street` string, nullable
      - `city` string, nullable
      - `cityTerritoryId` string, uuid, nullable
      - `district` string, nullable
      - `districtTerritoryId` string, uuid, nullable
      - `postalCode` string, nullable
      - `country` string, nullable
      - `isPrimary` boolean
      - `coordinates` Coordinates
        - `lat` number, double, nullable
        - `lng` number, double, nullable
  - `pageNumber` integer
  - `pageSize` integer
  - `totalCount` integer
  - `totalPages` integer
  - `hasPrevious` boolean
  - `hasNext` boolean

---

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