workload

Returns the users' workloads per day.

Changed on

Returns the users' workloads per day. 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

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/users/workload
  • Auth: HTTP bearer

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.

Response

OK

userIdstring uuid

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id GetUsersWorkload removed and replaced with workload_GetUsersWorkload