Search jobs
list_jobsSearch WorkMobile jobs by status, dates, users, types, priority, backlog and duration filters; returns job details with location withheld unless contact details are included.
Instructions
Search jobs with the filters POST /api/jobs/search documents: status IDs, estimated start date range, the mobile users they are allocated to, job types, a description, priority, backlog and whether a duration is set. Returns job ID, description, status ID, type, priority, dates and allocation; the job's location is withheld unless include_contact_details is set. In descriptions, emails, phone numbers, postcodes and coordinates are redacted, but names and street addresses typed into them are not. This search is a POST request that only reads. Pages hold 500 jobs; a page with fewer than 500 is the last.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page to start from (pages hold 500 rows, the smallest page size the API allows) | |
| backlog | No | Only backlog jobs (true) or only non-backlog jobs (false) (API `backlog`) | |
| priority | No | Only jobs with this priority (API `priority`) | |
| max_pages | No | Pages of 500 to fetch in this call | |
| status_ids | No | Only jobs with these status IDs (API field `jobStatusId`); decode them with list_job_statuses. WorkMobile's own example uses [1,2,3,5] for jobs that are not closed. | |
| description | No | Jobs matching this description (API `description`) | |
| max_results | No | Most rows to return; rows beyond this on pages already fetched are counted, not returned | |
| has_duration | No | Only jobs with a duration set (API `hasDuration`) | |
| job_type_ids | No | Only jobs of these types (API `jobTypeIds`) | |
| mobile_user_ids | No | Only jobs allocated to these mobile users (API `allocatedToUserId`) | |
| estimated_start_to | No | Jobs estimated to start on or before this (API `estimatedStartDateTimeTo`). A date alone means 23:59:59 UTC that day. | |
| estimated_start_from | No | Jobs estimated to start on or after this (API `estimatedStartDateTimeFrom`). A date alone means 00:00:00 UTC that day. | |
| include_contact_details | No | Include the job location (address), and stop redacting emails, phone numbers, postcodes and coordinates in descriptions and names. Off by default. Bank, card and payment details are never returned. | |
| order_by_estimated_start | No | Sort by estimated start (API orderBy on `estimatedStartDateTimeFrom`, as in WorkMobile's example) |