---
title: "Search Customers"
method: GET
path: "/customers/search"
---

# Search Customers

`GET /customers/search`

Fetches customers from all sources using query string.  

For example, you can fetch customers whose identifiers starting with 99455, or name that starts with ‘john’ and so on.

## Query parameters

- `q` string, required
- `limit` integer
- `offset` integer

## Headers

- `X-CAP-API-OAUTH-TOKEN` string

## Response `200`

200

- object
  - `pagination` object
    - `limit` integer
    - `offset` integer
    - `total` integer
  - `data` object[]
    - `userId` integer
    - `matchedIdentifiers` object[]
      - `idType` string
      - `idValue` string
      - `source` string
      - `accountId` string
    - `profiles` object[]
      - `source` string
      - `firstName` string
      - `lastName` string
  - `warnings` unknown[]
    - unknown
  - `errors` unknown[]
    - unknown

## Other responses

- `400` — 400

---

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