Returns the capacity of the specified user.

GET

https://api.awork.com/api/v1/users/:userId/capacity

Returns the capacity of the specified user. The response includes the user’s planning capacity.

Required Permissions

The user must have permission to access the requested resource.

Returns the capacity of the specified user. The response includes the user's planning capacity. <Check title="Required Permissions" icon="key">The user must have permission to access the requested resource.</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

userIdstringOptionalformat: "uuid"

The id of the user this capacity belongs to.

weeklyCapacityobjectOptional

createdOnstringOptionalformat: "date-time"

The date this user capacity was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this user capacity.

updatedOnstringOptionalformat: "date-time"

The date when this user capacity was last updated.

updatedBystringOptionalformat: "uuid"

The id of the user who updated the user capacity.

capacityPerWeekintegerOptionalRead-onlyDeprecated

The capacity of the user per week, in seconds.

Errors

401

Unauthorized Error