ZUzuper

Get Jobs 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. 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.

post/jobs/filter

Request

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

Request body

pageinteger
limitinteger

Max 1000 — larger values are rejected.

sort'ASC' | 'DESC'
sort_by'work_order_number' | 'job_priority' | 'scheduled_start_time' | 'due_date' | 'job_title' | 'created_at' | 'updated_at' | 'job_total' | 'current_job_status.status_name' | 'job_category.category_name' | 'none'
filter_rule_operator'AND' | 'OR'
filter.module_uidstring

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

fields_to_selectstring

Sparse fieldset selector.

preferred_timezonestring
cursorstring
prev_cursorstring
cursor_paginationboolean

Switches the response to the cursor-paginated shape.

last_pageboolean
include_custom_field_internal_objectboolean

Response

200

type'success'
dataobject[]

Job documents — same shape as GET /jobs, with assigned_to/assigned_to_team/created_by hydrated.

total_recordsinteger
current_pageinteger

0 in cursor-paginated mode.

total_pagesinteger

0 in cursor-paginated mode.

Changes