---
title: "Get Requests By Filter"
method: POST
path: "/request/filter"
---

# Get Requests By Filter

`POST /request/filter`

## Request

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

Rule-engine-based list endpoint — an alternative to the simple `filter.*` query params on the plain list endpoint, for building complex AND/OR filter conditions. `sort_by` is not validated against an enum — any field name is accepted, and `request_priority` is internally remapped to `request_priority_index`. `keyword` is a condition embedded inside `filter_rules`; if its value looks like an email address it resolves to a customer lookup by email instead of a text search. `filter.module_uid` restricts to specific request_uids.

## Request body

- object
  - `page` integer
  - `limit` integer
  - `sort` 'ASC' | 'DESC'
  - `filter_rules` object[]: Rule-engine filter conditions, ANDed/ORed per filter_rule_operator. Get the exact field key enum from this module's Meta Filter endpoint.
    - `key` 'request_priority' | 'request_title' | 'request_due_date' | 'customer_uid' | 'organization_uid' | 'property_uid' | 'asset_uid' | 'request_status.status_uid' | 'keyword'
    - `operator` 'EQUAL_TO' | 'NOT_EQUAL_TO' | 'CONTAINS' | 'NOT_CONTAINS' | 'GREATER_THAN' | 'LESS_THAN' | 'BETWEEN' | 'IS_EMPTY' | 'IS_NOT_EMPTY'
    - `value` unknown
    - `type` 'default_field' | 'nested_field' | 'custom_field'
  - `filter_rule_operator` 'AND' | 'OR'
  - `sort_by` string: Not validated against an enum by this endpoint — any field name is accepted.
  - `filter.module_uid` string
  - `preferred_timezone` string

## Response `200`

200

- object
  - `type` 'success'
  - `data` object[]: Request documents — same shape as GET /request.
  - `total_records` 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/request/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)