Returns the users' workloads per day. Takes into consideration weekly availability, absences, user capacity, planned efforts, as well as project budget.
Authentication
AuthorizationBearerSend your token in the Authorization: Bearer <token> header. See Authentication for API keys and OAuth.
Query parameters
userIdsstringRequiredThe ids of the users to get the workload for, as a comma-separated list of Guids.
intervalStartstringRequiredThe start of the interval to filter by.
intervalEndstringRequiredThe end of the interval to filter by.
roughPlanningFromintegerRequiredThe number of days from today when the rough planning should start.
fetchDetailsbooleanOptionalfalse(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.
ignoreCalendarEventsbooleanOptionalfalseWhether to ignore calendar events. Can significantly improve performance.
timezonestringOptionalAn optional Planner timezone. Defaults to UTC for API users and the account timezone for other users.
Responses
200 OK
application/json
userIdstringOptionalworkloadsarray of object or nullOptionalShow 8 properties
datestringOptionalThe date of the calculated utilisation.
durationnumberOptionalThe total duration (in seconds) of all the items included in the user's workload calculation: Calendar events + Scheduled Tasks + Assigned Tasks + Time Bookings + Recurring Tasks.
userCapacityinteger or nullOptionalThe total capacity of the user on this day.
remainingUserCapacityinteger or nullOptionalThe remaining capacity of the user on this day.
projectsarray of object or nullOptionalShow 7 properties
idstringOptionalnamestring or nullOptionalcompanyobjectOptionalShow 3 properties
idstring or nullOptionalnamestring or nullOptionalhasImagebooleanOptionaltasksarray of object or nullOptionalShow 7 properties
idstringOptionalnamestring or nullOptionaldurationinteger or nullOptionalThe duration of the planned effort of the user for this task. Includes the duration of recurring tasks if the IsRecurring flag is set to true. Omitted when the requester cannot read the planned effort of the task's project.
taskStatusobjectOptionalShow 3 properties
idstringOptionalnamestring or nullOptionalThe name of the entity.
typestring or nullOptionalThe type of the status.
taskSchedulesarray of object or nullOptionalShow 3 properties
durationintegerOptionalfromstringOptionaltostringOptionalisAnonymizedboolean or nullOptionalThis will be true if the user doesn't have access to the task. In that case the Name and the Status will be shadowed.
isRecurringbooleanOptionalWhether the task has a recurrency rule.
timeBookingsarray of object or nullOptionalShow 4 properties
idstringOptionaldescriptionstring or nullOptionaldurationintegerOptionalisAnonymizedboolean or nullOptionalThis will be true if the user doesn't have access to the project of time booking (if related to a project). In that case the Description will be shadowed.
isAnonymizedboolean or nullOptionalThis will be true if the user doesn't have access to the project. In that case the Name and the ClientName will be shadowed.
hasImagebooleanOptionaltasksarray of object or nullOptionalShow 7 properties
idstringOptionalnamestring or nullOptionaldurationinteger or nullOptionalThe duration of the planned effort of the user for this task. Includes the duration of recurring tasks if the IsRecurring flag is set to true. Omitted when the requester cannot read the planned effort of the task's project.
taskStatusobjectOptionalShow 3 properties
idstringOptionalnamestring or nullOptionalThe name of the entity.
typestring or nullOptionalThe type of the status.
taskSchedulesarray of object or nullOptionalShow 3 properties
durationintegerOptionalfromstringOptionaltostringOptionalisAnonymizedboolean or nullOptionalThis will be true if the user doesn't have access to the task. In that case the Name and the Status will be shadowed.
isRecurringbooleanOptionalWhether the task has a recurrency rule.
appointmentsarray of object or nullOptionalShow 3 properties
providerNamestring or nullOptionalcalendarNamestring or nullOptionaldurationintegerOptionalcalendarAbsencesarray of object or nullOptionalCalendar out-of-office entries grouped by calendar that reduce capacity for this day. Only returned when fetchDetails is enabled.
Show 3 properties
providerNamestring or nullOptionalcalendarNamestring or nullOptionaldurationintegerOptional400 Bad Request
application/json
codestringRequired1 The error code.
descriptionstringRequired1 The description of the error.
linkstringRequired1 The link to the API documentation page.
detailsarray of string or nullOptionalA list of details describing the error.
validationErrorsarray of object or nullOptionalIf a validation error occurred, this contains the validation errors for each property.
Show 2 properties
propertystring or nullOptionalThe name of the property that failed validation.
messagestring or nullOptionalThe reason why this property failed validation.
traceIdstring or nullOptionalThe request trace id for tracking the request.
401 Unauthorized
application/json
codestringRequired1 The error code.
descriptionstringRequired1 The description of the error.
linkstringRequired1 The link to the API documentation page.
detailsarray of string or nullOptionalA list of details describing the error.
validationErrorsarray of object or nullOptionalIf a validation error occurred, this contains the validation errors for each property.
Show 2 properties
propertystring or nullOptionalThe name of the property that failed validation.
messagestring or nullOptionalThe reason why this property failed validation.
traceIdstring or nullOptionalThe request trace id for tracking the request.