---
title: "Get Users By Generic Filter"
method: POST
path: "/users/filter"
---

# Get Users By Generic Filter

`POST /users/filter`

## Request

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

## Query parameters

- `limit` integer, required
- `page` integer, required
- `sort_by` ''name'' | ''first_name'' | ''last_name'' | ''emp_code'' | ''created_at'', required
- `sort` ''DESC'' | ''ASC'', required

## Request body

- object
  - `filter_rules` object[], required
    - `displayKeyValue` string[]
    - `field_type` string
    - `key` string
    - `module` string
    - `operator` 'EQUAL_TO' | 'GREATER_THAN' | 'LESS_THAN' | 'BETWEEN' | 'NOT_EQUAL_TO' | 'CONTAINS' | 'NOT_CONTAINS' | 'IS_EMPTY' | 'IS_NOT_EMPTY' | 'LESS_THAN_EQUAL_TO' | 'IN' | 'NOT_IN'
    - `type` string
    - `value` string[]

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `user_uid` string
    - `first_name` string
    - `last_name` string
    - `email` string
    - `external_login_id` string
    - `home_phone_number` string
    - `designation` string
    - `emp_code` string
    - `prefix` unknown
    - `work_phone_number` string
    - `mobile_phone_number` string
    - `profile_picture` string
    - `hourly_labor_charge` integer
    - `is_active` boolean
    - `is_deleted` boolean
    - `created_at` string
    - `updated_at` string
    - `role` object
      - `role_uid` string
      - `role_name` string
      - `role_key` string
    - `access_role` object
      - `access_role_uid` string
      - `role_name` string
      - `role_description` string
    - `custom_fields` object[]
      - `label` string
      - `value` string
      - `type` string
      - `hide_to_fe` boolean
      - `hide_field` boolean
      - `read_only` boolean
      - `_id` string
  - `total_records` integer
  - `total_pages` integer
  - `current_page` integer

## Other responses

- `400`: 400
- `500`: 500

## Changes

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

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/users/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)