v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB

Routes

Users

Capacity

Exceptions

Get Capacity Exceptions by User

Gets capacity exception records for a specific user.

capacityMinutes is the user's available capacity per day for each date in the exception range.

Query behavior:

locations scopes by user location membership.
startDate/endDate filter by date overlap (YYYY-MM-DD).
cursor/limit paginate results.

Response fields include: exceptionID, userID, createdByUserID, exceptionStartDate, exceptionEndDate, capacityMinutes, hoursPerDay, minutesPerDay, exceptionTitle, exceptionNotes, exceptionType.

get/v2/users/capacity/exceptions/{userID}

Query parameters

locationsinteger

Required comma-separated location IDs used to scope the user access context.

startDatestring

Optional lower date bound (YYYY-MM-DD) for overlap filtering.

endDatestring

Optional upper date bound (YYYY-MM-DD) for overlap filtering. Must be >= startDate when both are present.

cursorinteger

Optional ID cursor for keyset pagination.

limitinteger

Optional max rows per page.

Response

Get User Capacity Exceptions

exceptionIDinteger

userIDinteger

createdByUserIDinteger

exceptionStartDatestring date

exceptionEndDatestring date

capacityMinutesinteger

hoursPerDayinteger

minutesPerDayinteger

exceptionTitlestring

exceptionNotesstring

{"stackTrail":"paths:/v2/users/capacity/exceptions/{userID}:get:responses:200:content:application/json:schema:items:properties:exceptionType","oasType":"schema","type":"unknown","description":"Structured planned/unplanned classification. Null when unset."}