---
title: "Returns the users' workloads per day."
method: GET
path: "/users/workload"
tags: ["workload"]
---

# Returns the users' workloads per day.

`GET /users/workload`

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>

## Query parameters

- `userIds` string, required
- `intervalStart` string, date-time, required
- `intervalEnd` string, date-time, required
- `roughPlanningFrom` integer, required
- `fetchDetails` boolean
- `ignoreCalendarEvents` boolean

## Headers

- `Authorization` string, required

## Response `200`

OK

- GetWorkloadForUsersResult[]
  - `userId` string, uuid
  - `workloads` WorkloadModel[], nullable
    - `date` string, date-time — The date of the calculated utilisation.
    - `duration` string — The 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.
    - `userCapacity` integer, nullable — The total capacity of the user on this day.
    - `remainingUserCapacity` integer, nullable — The remaining capacity of the user on this day.
    - `projects` WorkloadProjectInfo[], nullable
      - `id` string, uuid
      - `name` string, nullable
      - `company` WorkloadCompany
        - `id` string, uuid, nullable
        - `name` string, nullable
        - `hasImage` boolean
      - `tasks` WorkloadTaskInfo[], nullable
        - `id` string, uuid
        - `name` string, nullable
        - `duration` integer — The 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.
        - `taskStatus` WorkloadStatusModel
          - `id` string, uuid
          - `name` string, nullable — The name of the entity.
          - `type` string, nullable — The type of the status.
        - `taskSchedules` WorkloadTaskScheduleInfo[], nullable
          - `duration` integer
          - `from` string, date-time
          - `to` string, date-time
        - `isAnonymized` boolean, nullable — This will be true if the user doesn't have access to the task. In that case the Name and the Status will be shadowed.
        - `isRecurring` boolean — Whether the task has a recurrency rule.
      - `timeBookings` WorkloadTimeBookingInfo[], nullable
        - `id` string, uuid
        - `description` string, nullable
        - `duration` integer
        - `isAnonymized` boolean, nullable — This 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.
      - `isAnonymized` boolean, nullable — This will be true if the user doesn't have access to the project. In that case the Name and the ClientName will be shadowed.
      - `hasImage` boolean
    - `tasks` WorkloadTaskInfo[], nullable
      - `id` string, uuid
      - `name` string, nullable
      - `duration` integer — The 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.
      - `taskStatus` WorkloadStatusModel
        - `id` string, uuid
        - `name` string, nullable — The name of the entity.
        - `type` string, nullable — The type of the status.
      - `taskSchedules` WorkloadTaskScheduleInfo[], nullable
        - `duration` integer
        - `from` string, date-time
        - `to` string, date-time
      - `isAnonymized` boolean, nullable — This will be true if the user doesn't have access to the task. In that case the Name and the Status will be shadowed.
      - `isRecurring` boolean — Whether the task has a recurrency rule.
    - `appointments` WorkloadAppointments[], nullable
      - `providerName` string, nullable
      - `calendarName` string, nullable
      - `duration` integer
    - `calendarAbsences` WorkloadAppointments[], nullable — Calendar out-of-office entries grouped by calendar that reduce capacity for this day. Only returned when fetchDetails is enabled.
      - `providerName` string, nullable
      - `calendarName` string, nullable
      - `duration` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/awork-io/apis/api-v1-reference.md) · [All operations](https://skmtc.net/awork-io/apis/api-v1-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/awork-io/api-v1-reference/versions/f784a53f60df/schema)