Get Jobs By Filter

post

https://{dc-region}.zuperpro.com/api/jobs/filter

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. Get the field key enum for filter_rules from the corresponding Meta Filter endpoint. keyword (free text) is special-cased and matches job_title/work_order_number/zip codes rather than going through the rule engine.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

page

integer

Defaults to 1

limit

integer

Defaults to 10

Max 1000 — larger values are rejected.

sort

string

enum

Defaults to DESC

Allowed:

sort_by

string

enum

Defaults to work_order_number

filter_rules

array of objects

Rule-engine filter conditions, ANDed/ORed per filter_rule_operator. type must match the type the module's Meta Filter endpoint declares for that key (fieldDataKey) — sending the wrong type is rejected with an error. A handful of keys shared across modules (e.g. scheduled_date_range, schedule_status, asset, property, assigned_to, auto_charge.status) require module to be set to this endpoint's module (e.g. "JOB") since the query engine branches on it directly.

filter_rules

filter_rule_operator

string

enum

Defaults to AND

Allowed:

filter.module_uid

string

Comma-separated list of this module's own UIDs to restrict to.

fields_to_select

string

Sparse fieldset selector.

preferred_timezone

string

cursor

string

prev_cursor

string

cursor_pagination

boolean

Switches the response to the cursor-paginated shape.

last_page

boolean

include_custom_field_internal_object

boolean

Responses

200200

400400