List tasks
Changed onWork as we hold it: what was issued, what became of it, and how it measured up.
kpi_fact against kpi_plan, plus time_worked, are the point of reading a task back — what was asked for, what was achieved, how long it took. status says where it got to.
Twenty-four fields, not the forty the table has. Eight of the rest configure how the mobile application behaves while the job is done — whether it demands a photo, records a location, keeps the steps in order. That is a task template's business, and neither useful nor settable here.
include=items adds the steps, include=managers the people who approve or are notified. Without them the keys are absent, never null standing in for "not asked for".
updated_since is what an export should page on, as an instant: a task moves through its statuses inside a working day, so a caller polling for completions needs to say which minute.
statuses takes created, started, paused, completed, incompleted and pastdue. Three more exist in the database and none is offered: finished and unfinished are deprecated spellings, and pending is reached only through approval. A value that cannot be explained is worse than one that is absent.
Oldest first. A first call lands on the earliest task this company ever issued, which for a long-standing one is years back. That order is what lets a full export finish in one walk, and it is not what you want for "what happened lately": ask with updated_since, or narrow with due_from and due_to.
Request
- Base URL: https://api.clockster.com
- URL: https://api.clockster.com/company/v3/tasks
- Auth: HTTP bearer
Query parameters
How many rows one page holds. Defaults to 50.
The meta.next_cursor of the previous page. Omit it for the first. A cursor is bound to the filters it was issued under — change them and start again.
Only rows carrying these keys of yours. The other half of an upsert: write with your key, read back with it.
Only rows belonging to these people, by id.
Only rows in these categories.
Only rows in these states.
Only rows switched on (true) or off (false). Omit for both.
Free text over the names the section lists.
Due at or after this date (YYYY-MM-DD).
Due at or before this date (YYYY-MM-DD).
Only rows changed at or after this instant (ISO 8601). The cheap way to sync: ask for what moved, not for everything.
Relations to load, comma-separated. Anything not named is absent from the answer rather than null.
Response
Success
Changes
- info
the endpoint scheme security
companyTokenwas added to the API
- info
- breaking
removed the required property
//from the response with the status
- breaking