ZUzuper

Get Jobs By Group Filter (Kanban)

Changed on

Returns, per job status within a category, a capped list of jobs plus the full count — the Job Kanban board's per-column data. Does not check the enable_kanban_view company policy (unlike Get Jobs Summary). Returns 200 with an empty array if the category has no statuses.

post/jobs/group/filter

Request

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

Request body

job_category_uidstring required
filter_rulesobject[]
sort'ASC' | 'DESC'
sort_by'created_at' | 'updated_at' | 'job_title' | 'job_priority' | 'scheduled_start_time' | 'due_date' | 'work_order_number' | 'work_order_string' | 'job_total' | 'job_category.category_name'
countinteger

Max jobs returned per status column.

fields_to_selectstring

Comma-separated top-level keys to restrict the job object to. job_total is always included.

Response

200

Changes