Skip to main content
POST

Request

string
Set this if you want to retrieve a specific job.
array
Use this field to retrieve multiple specific jobs.
string
Retrieve the job with this ID from your own system (the uidSecondary you set when creating it). Returns that one job, whatever its day and worker, or an empty jobs list.
number
day is optional and defaults to today. To retrieve jobs with no date assigned, set day:0. To specifically ignore the day field, set day:-1.
string
To retrieve jobs that are not assigned to a worker, set worker:"". To request jobs assigned to any worker, set worker:"+". To request all jobs, assigned and unassigned, for a specific date, set worker:"*". Without worker, only jobs assigned to the caller are returned; with an API key the caller is the company account, so this is usually empty.
number
team is an optional filter to only request jobs for a specific team.
array
Only jobs of these teams. Use instead of team for several teams.
boolean
default:false
With teamIds, also include jobs that have no team.
number
Optional filter to request a specific job.
array
Optional filter to request multiple specific jobs.
number
default:0
progressSuccess is an optional filter to only retrieve jobs that are marked as successfully completed. For this, set the value to 1, else set it either to 0 or do not set the field at all.
number
default:0
progressActive is an optional filter to only retrieve jobs that are not marked as completed (neither success nor issue). For this, set the value to 1, else set it either to 0 or do not set the field at all.
number
default:0
Set to 1 to include archived jobs in the results. Defaults to 0 (exclude archived jobs). Deleted jobs are never returned.
object
Optional sorting and pagination configuration object with the following properties:
  • field (string, required): Field name to sort by (e.g., “tsCreated”, “priority”, “number”)
  • ascending (boolean, required): Sort direction - true for ascending, false for descending
  • limit (number, required): Maximum number of jobs to return
  • skip (number, required): Number of jobs to skip (for pagination)
  • from (long): Only jobs whose sort field is at or after this value (e.g. a timestamp in milliseconds when sorting by “tsCreated”)
  • until (long): Only jobs whose sort field is at or before this value
  • status (number): 0 normal jobs only, 1 archived jobs only, -1 (default) both
When sort is provided, the day parameter defaults to undefined (all days) unless explicitly specified, and archived jobs are included. A missing required property returns status -1.
object
Optional filters, mostly used together with sort for paging:
  • filterIds (array): "updated" keeps jobs changed at or after updatedSince, "today" jobs of today, "nodate" jobs without a date
  • updatedSince (long): timestamp in milliseconds for "updated". Defaults to one hour ago.
  • text (string): jobs whose name, address or notes contain this text, ignoring case; a job id or order id also matches
  • allDates (boolean): search all dates instead of one day
With query and sort, an empty sort field orders by the time the job was last saved.
boolean
default:false
Leave out signatureSvg to keep responses small.

RESPONSE

totalCount and hasMore come with sort or query: totalCount is the number of matching jobs, and hasMore is true when more pages follow.

Keeping jobs in sync

To copy changes into your own system, ask regularly for the jobs saved since your last run, oldest first, page by page:
Increase skip by limit while hasMore is true. Next time, use the newest tsSaved you received as updatedSince. Archived jobs are included (their status is archived); deleted jobs are not returned.