Returns the capacity of the specified user. | awork API

Returns the capacity of the specified user. User planning data or admin permissions are required if the capacity of the specified user does not belong to the calling user.

Required Permissions

Any authenticated user.

Returns the capacity of the specified user. User planning data or admin permissions are required if the capacity of the specified user does not belong to the calling user. <Check title="Required Permissions">Any authenticated user.</Check>

Authentication

AuthorizationBearer

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

Path parameters

userIdstringRequiredformat: "uuid"

The id of the user.

Response

userIdstring or nullformat: "uuid"

The id of the user this capacity belongs to.

weeklyCapacityobject or null

createdOnstring or nullformat: "date-time"

The date this user capacity was created.

createdBystring or nullformat: "uuid"

The id of the user who created this user capacity.

updatedOnstring or nullformat: "date-time"

The date when this user capacity was last updated.

updatedBystring or nullformat: "uuid"

The id of the user who updated the user capacity.

capacityPerWeekinteger or nullDeprecated

The capacity of the user per week, in seconds.

1	import requests
2
3	url = "https://api.awork.com/api/v1/users/userId/capacity"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"userId": "123e4567-e89b-12d3-a456-426614174000",
3	"weeklyCapacity": {
4	"mon": 28800,
5	"tue": 28800,
6	"wed": 28800,
7	"thu": 28800,
8	"fri": 28800,
9	"sat": 0,
10	"sun": 0
11	},
12	"createdOn": "2024-01-15T09:30:00Z",
13	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
14	"updatedOn": "2024-01-15T09:30:00Z",
15	"updatedBy": "123e4567-e89b-12d3-a456-426614174000",
16	"capacityPerWeek": 126000
17	}