Returns the users' workloads per day. | awork API

1 import requests 2 3 url = "https://api.awork.com/api/v1/users/workload" 4 5 querystring = {"intervalStart":"intervalStart","intervalEnd":"intervalEnd","roughPlanningFrom":"1"} 6 7 headers = {"Authorization": "Bearer <token>"} 8 9 response = requests.get(url, headers=headers, params=querystring) 10 11 print(response.json())

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

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">The user must be an admin or have user-planning-data:read permissions.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

userIdsstringOptional

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

intervalStartstringRequiredformat: "date-time"

The start of the interval to filter by.

intervalEndstringRequiredformat: "date-time"

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

userIdstring or nullformat: "uuid"

workloadslist of objects or null