Documentation
Worker worktime period analysis details. Returns { worker_ids, from, month, workday_length,
overtime_length, num_days, day_breakdown, workers, worker_groups, departments }
from and num_days describe the period actually covered, which is not always the one asked
for - see the from parameter.
Hours are always split by calendar day: when work crosses midnight, each part counts on
the day it was worked.
The response has a fixed structure and may not include every field these records carry elsewhere in the API.
Approval: both are returned, kept apart. Approved hours are in work and total_work, unapproved
hours in work_notapproved and total_work_notapproved. Work whose start and stop time are equal
is always left out.
Parameters
| Parameter |
Type |
Required? |
Format |
Description |
| from |
date |
false |
YYYY-MM-DD |
Date as Y-m-d, for example 2026-08-28. Defaults to the first day of the current month when omitted. For workers without ROLE_ADMIN, ROLE_OBSERVER, ROLE_DISPATCHER, ROLE_VEHICLE_SERVICE or ROLE_STORAGE the period starts no earlier than the first day of the month 3 months ago, and num_days and the hours reported cover only the part of the period that is left. |
| to |
date |
false |
YYYY-MM-DD |
Date as Y-m-d, for example 2026-08-28. The whole of that day is included. When omitted the period runs to the end of the current month. |
| period |
date |
false |
YYYY-MM-DD |
Date as Y-m-d, for example 2026-08-28. The month this date falls in is the period returned. A month more than 3 months back comes back empty for workers who are subject to the limit described under from. |
| worker_id |
integer |
false |
|
Filter by one Worker |
| worktype_id |
integer |
false |
|
Filter by one Worktype |
| main_facility_id |
integer |
false |
|
Filter by one Main Facility |
| cost_account_id |
integer |
false |
|
Filter by one Cost Account |
| project_id |
integer |
false |
|
Filter by one Project |
| department_ids |
string |
false |
|
Comma-separated department ids to restrict the result to. |
| group_ids |
string |
false |
|
Comma-separated worker group ids. |
Headers
| Name |
Required? |
Description |
| X-Terake-Api-Key |
false |
Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter. |