---
title: "Get Customer details V3"
method: POST
path: "/v2/customer/filter"
---

# Get Customer details V3

`POST /v2/customer/filter`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/v2/customer/filter`
- Auth: API key in header `x-api-key`

## Request body

- object
  - `limit` string
  - `page` string
  - `sort` 'ASC' | 'DESC'
  - `sort_by` 'work_order_number' | 'job_priority' | 'scheduled_start_time' | 'due_date' | 'none'
  - `filter_rules` object[]
    - `module` string, required
    - `type` 'default_field' | 'nested_field' | 'custom_field', required
    - `key` 'work_order_number' | 'job_title' | 'job_priority' | 'current_job_status.status_type' | 'is_recurrence' | 'job_tags' | 'delayed_job' | 'parent_job' | 'job_feedback.rating' | 'job_type' | 'job_category_uid' | 'status_uid' | 'route_uid' | 'request_uid' | 'assigned_to_team.team_uid' | 'assigned_to.user_uid' | 'assigned_to' | 'schedule_status' | 'scheduled_date_range' | 'scheduled_start_time' | 'scheduled_end_time' | 'due_date' | 'customer_address.street' | 'customer_address.state' | 'customer_address.zip_code' | 'customer_address.city' | 'customer_billing_address.street' | 'customer_billing_address.state' | 'customer_billing_address.zip_code' | 'customer_billing_address.city' | 'created_by' | 'created_at' | 'updated_at' | 'customer_uid' | 'organization_uid' | 'property_uid' | 'asset_uid' | 'contract_uid', required
    - `operator` 'EQUAL_TO' | 'NOT_EQUAL_TO' | 'GREATER_THAN' | 'LESS_THAN' | 'BETWEEN' | 'CONTAINS' | 'NOT_CONTAINS' | 'IS_EMPTY' | 'IS_NOT_EMPTY', required
    - `value` 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/v2/customer/filter/post.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)