v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB

Routes

Users

Capacity

Exceptions

Get Capacity Exceptions by Location

Gets capacity exception records across users for the requested locations.

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

Query behavior:

locations is required.
users optionally narrows results to specific users.
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

Query parameters

locationsstring

Required comma-separated location IDs.

usersstring

Optional comma-separated user IDs filter.

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 Capacity Exceptions By Location

exceptionIDinteger

userIDinteger

createdByUserIDinteger

exceptionStartDatestring date

exceptionEndDatestring date

capacityMinutesinteger

hoursPerDayinteger

minutesPerDayinteger

exceptionTitlestring

exceptionNotesstring

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