Returns the users' workloads per day. | awork API

1 curl -G https://api.awork.com/api/v1/users/workload \ 2 -H "Authorization: Bearer <token>" \ 3 -d intervalStart=intervalStart \ 4 -d intervalEnd=intervalEnd \ 5 -d roughPlanningFrom=0

1 [ 2 { 3 "userId": "123e4567-e89b-12d3-a456-426614174000", 4 "workloads": [ 5 { 6 "date": "date", 7 "duration": 0, 8 "userCapacity": null, 9 "remainingUserCapacity": null, 10 "projects": [ 11 { 12 "id": "123e4567-e89b-12d3-a456-426614174000", 13 "name": null, 14 "company": { 15 "id": "123e4567-e89b-12d3-a456-426614174000", 16 "name": null, 17 "hasImage": false 18 }, 19 "tasks": [ 20 { 21 "id": "123e4567-e89b-12d3-a456-426614174000", 22 "name": null, 23 "duration": 0, 24 "taskStatus": { 25 "id": "123e4567-e89b-12d3-a456-426614174000", 26 "name": "Website Design and Implementation", 27 "type": null 28 }, 29 "taskSchedules": [ 30 { 31 "duration": 0, 32 "from": "from", 33 "to": "to" 34 } 35 ], 36 "isAnonymized": null, 37 "isRecurring": false 38 } 39 ], 40 "timeBookings": [ 41 { 42 "id": "123e4567-e89b-12d3-a456-426614174000", 43 "description": null, 44 "duration": 0, 45 "isAnonymized": null 46 } 47 ], 48 "isAnonymized": null, 49 "hasImage": false 50 } 51 ], 52 "tasks": [ 53 { 54 "id": "123e4567-e89b-12d3-a456-426614174000", 55 "name": null, 56 "duration": 0, 57 "taskStatus": { 58 "id": "123e4567-e89b-12d3-a456-426614174000", 59 "name": "Website Design and Implementation", 60 "type": null 61 }, 62 "taskSchedules": [ 63 { 64 "duration": 0, 65 "from": "from", 66 "to": "to" 67 } 68 ], 69 "isAnonymized": null, 70 "isRecurring": false 71 } 72 ], 73 "appointments": [ 74 { 75 "providerName": null, 76 "calendarName": null, 77 "duration": 0 78 } 79 ] 80 } 81 ] 82 } 83 ]

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.

Required Permissions

The user must be an admin or have user-planning-data:read permissions.

Query parameters

userIdslist of UUIDsOptional

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

intervalStartdatetimeRequired

The start of the interval to filter by.

intervalEnddatetimeRequired

The end of the interval to filter by.

roughPlanningFromintegerRequired

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

fetchDetailsbooleanOptionalDefaults to false

(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.

ignoreCalendarEventsbooleanOptionalDefaults to false

Whether to ignore calendar events. Can significantly improve performance.

Response

userIdUUID or null

workloadslist of objects or null

Required Permissions

Headers

Query parameters

Response