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

# Customer Search

`GET /customers/search`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/customers/search`
- Auth: API key in header `x-api-key`

## Query parameters

- `page` integer
- `count` integer
- `q` string, required

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `customer_uid` string
    - `customer_first_name` string
    - `customer_last_name` string
    - `customer_category` object
      - `category_uid` string
      - `category_name` string
    - `customer_organization` object
      - `organization_uid` string
      - `organization_name` string
      - `organization_email` string
      - `organization_address` object
        - `city` string
        - `state` string
        - `street` string
        - `country` string
        - `landmark` unknown
        - `zip_code` string
        - `first_name` unknown
        - `last_name` unknown
        - `phone_number` unknown
        - `email` unknown
        - `geo_cordinates` number[]
        - `point_coordinates` object
          - `type` string
          - `coordinates` number[]
      - `organization_billing_address` object
        - `city` string
        - `state` string
        - `street` string
        - `country` string
        - `landmark` unknown
        - `zip_code` string
        - `first_name` unknown
        - `last_name` unknown
        - `phone_number` unknown
        - `email` unknown
        - `geo_cordinates` number[]
        - `point_coordinates` object
          - `type` string
          - `coordinates` number[]
      - `is_active` boolean
      - `is_deleted` boolean
    - `customer_company_name` string
    - `customer_email` string
    - `no_of_jobs` integer
    - `customer_contact_no` object
      - `mobile` string
      - `home` string
      - `work` string
    - `customer_tags` unknown[]
      - unknown
    - `customer_address` object
      - `city` string
      - `state` string
      - `street` string
      - `country` string
      - `landmark` unknown
      - `zip_code` string
      - `first_name` unknown
      - `last_name` unknown
      - `phone_number` unknown
      - `email` unknown
      - `geo_cordinates` number[]
      - `point_coordinates` object
        - `type` string
        - `coordinates` number[]
    - `customer_billing_address` object
      - `city` string
      - `state` string
      - `street` string
      - `country` string
      - `landmark` unknown
      - `zip_code` string
      - `first_name` unknown
      - `last_name` unknown
      - `phone_number` unknown
      - `email` unknown
      - `geo_cordinates` number[]
      - `point_coordinates` object
        - `type` string
        - `coordinates` number[]
    - `custom_fields` unknown[]
      - unknown
    - `has_sla` boolean
    - `accounts` object
      - `ltv` integer
      - `receivables` integer
      - `credits` integer
    - `is_active` boolean
    - `is_portal_enabled` boolean
    - `account_manager` unknown
    - `has_card_on_file` boolean
    - `tax` object
      - `tax_exempt` boolean
    - `created_at` string
    - `id` string
  - `total_records` integer
  - `current_page` integer
  - `total_pages` integer

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/customers/search/get.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)