> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.awork.com/workload/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.awork.com/_mcp/server.

# Workload & Planning

> Workload & Planning API Reference.

![awork workload planning calendar with tasks, meetings, and availability](/_fern-img/f6c034ea05738c12e7546e7afa60dfabb97cb646b28803b666eae546ca3088af.webp)

Workload data shows how much capacity users have available for planned work on each day. The calculation includes assigned and scheduled tasks, time bookings, calendar events, recurring tasks, weekly availability, and absences.

> **Note**
>
> Workload is available to administrators and users with `user-planning-data:read` permission. The endpoint uses OAuth with the `full_access` scope.

## Getting a user's workload

Provide one or more user ids and an interval. `roughPlanningFrom` is the number of days from today at which rough planning starts; set it to `0` for a normal daily view. User ids are passed as a comma-separated list.

**`Get workload for a week`**

```sh title="Get workload for a week"
curl 'https://api.awork.com/api/v1/users/workload?userIds=123e4567-e89b-12d3-a456-426614174000&intervalStart=2026-09-14T00:00:00Z&intervalEnd=2026-09-20T23:59:59Z&roughPlanningFrom=0' \
  -H 'Authorization: Bearer {token}'
```

The response contains one entry per requested user and a workload record for each day:

**`Response`**

```json title="Response"
[
  {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "workloads": [
      {
        "date": "2026-09-14T00:00:00Z",
        "duration": 21600,
        "userCapacity": 28800,
        "remainingUserCapacity": 7200
      }
    ]
  }
]
```

`duration`, `userCapacity`, and `remainingUserCapacity` are measured in seconds. For a single-day query, add `fetchDetails=true` to include the projects, tasks, appointments, and calendar absences contributing to the calculation. If calendar data is not needed, `ignoreCalendarEvents=true` can improve response time.

Learn more about [workload & planning](https://support.awork.com/en/articles/the-planner-x2LDBA9A1rIq).

> Workload & Planning API Reference.