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

# Search Customers

`GET /customer/search`

Lets you fetch customers based on partial or complete keywords passed. You can fetch customers by name, customer identifier, registered store id, registered date, loyalty points, lifetime points, lifetime purchases amount, current tier, transaction amount, and custom field values.

## Query parameters

- `format` 'json' | 'xml'
- `q` string, required

## Response `200`

200

- object
  - `response` object
    - `status` object
      - `success` string
      - `code` string
      - `message` string
    - `customer` object
      - `count` string
      - `start` string
      - `rows` string
      - `results` object
        - `item` object[]
          - `user_id` string
          - `org_id` string
          - `firstname` string
          - `lastname` string
          - `mobile` string
          - `email` string
          - `external_id` string
          - `loyalty_points` string
          - `lifetime_points` string
          - `lifetime_purchases` string
          - `current_slab` string
          - `registered_on` string
          - `registered_by` string
          - `last_trans_value` string
          - `attributes` object
            - `attribute` object
              - …

## 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)