v1

latestOpenAPI 3.1.02026-08-066984441.1 MB

workload

Returns the users' workloads per day.

Returns the users' workloads per day for projects, tasks, task schedules and calendar events that have an overlap with the interval specified by intervalStart and intervalEnd. Takes into consideration weekly availability, absences, user capacity, planned efforts, as well as project budget.

<Check title="Required Permissions" icon="key">The user must be an admin or have user-planning-data:read permissions.</Check>

get/users/workload

Query parameters

userIdsstring required

The ids of the users to get the workload for, as a comma-separated list of Guids.

intervalStartstring date-time required

The start of the interval to filter by.

intervalEndstring date-time required

The end of the interval to filter by.

roughPlanningFrominteger required

The number of days from today when the rough planning should start.

fetchDetailsboolean

(Optional - default: false) If set to true, the result will contain the hierarchy of elements that are contributing to the workload (projects, tasks, appointments). Otherwise it will return only the workload value. Works only for single day queries.

ignoreCalendarEventsboolean

Whether to ignore calendar events. Can significantly improve performance.

Headers

Authorizationstring required

Bearer authentication

Response

userIdstring uuid