ZUzuper

Get Job Routes 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. Unlike other modules, keyword here is a condition embedded directly inside filter_rules ({"key": "keyword", ...}), not a separate top-level body field. Invalid sort_by returns 400.

post/routes/filter

Request

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

Request body

pageinteger
limitinteger
sort'ASC' | 'DESC'
filter_rule_operator'AND' | 'OR'
sort_by'route_name' | 'departure' | 'total_jobs'

Response

200

type'success'
dataobject[]

Job route documents — same shape as GET /routes.

total_recordsinteger

Changes