Get Requests By Filter

Changed on

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.

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

Request body

pageinteger
limitinteger
sort'ASC' | 'DESC'
filter_rule_operator'AND' | 'OR'
sort_bystring

Not validated against an enum by this endpoint — any field name is accepted.

filter.module_uidstring
preferred_timezonestring

Response

200

type'success'
dataobject[]

Request documents — same shape as GET /request.

total_recordsinteger

Changes