Returns the capacity of the specified user.

GET

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.

Path parameters

userIdstringRequired

Response

userIdstringOptional

The id of the user this capacity belongs to.

weeklyCapacityobjectOptional

createdOndatetimeOptional

The date this user capacity was created.

createdBystringOptional

The id of the user who created this user capacity.

updatedOndatetimeOptional

The date when this user capacity was last updated.

updatedBystringOptional

The id of the user who updated the user capacity.

capacityPerWeekintegerOptionalDeprecated

The capacity of the user per week, in seconds.

Updates the capacity of the specified user.

Up Next

Built with

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	}

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