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" icon="key">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

userIdstringformat: "uuid"

The id of the user this capacity belongs to.

weeklyCapacityobject

createdOndatetime

The date this user capacity was created.

createdBystringformat: "uuid"

The id of the user who created this user capacity.

updatedOndatetime

The date when this user capacity was last updated.

updatedBystringformat: "uuid"

The id of the user who updated the user capacity.

capacityPerWeekintegerRead-onlyDeprecated

The capacity of the user per week, in seconds.

Errors

401

Unauthorized Error

1	{
2	"userId": "9f8b7c6d-1234-4a56-b789-0a1b2c3d4e5f",
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-04-01T08:00:00Z",
13	"createdBy": "4a3b2c1d-5678-4e90-b123-456789abcdef",
14	"updatedOn": "2024-05-10T15:45:00Z",
15	"updatedBy": "4a3b2c1d-5678-4e90-b123-456789abcdef",
16	"capacityPerWeek": 144000
17	}

1	curl https://api.awork.com/api/v1/users/userId/capacity \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json"