v1
latestOpenAPI 3.1.02026-08-0420819698.7 KBRoutes
Users
Capacity
Schedules
Get Capacity Schedules
Returns per-user daily capacity rows for a date range, including applied precedence details.
Precedence order: exception > holiday > userSchedule > profileSchedule > default.
Pagination:
- cursor is a zero-based offset.
- limit max is 100.
Date limits:
- startDate and endDate are required (YYYY-MM-DD).
- Date range cannot exceed 31 days.
Response notes:
- range now contains only startDate and endDate.
- pagination contains cursor, limit, totalUsers, and nextCursor.
get/v2/users/capacity/schedules
Query parameters
locationsstring
Required comma-separated location IDs to scope users.
usersstring
Optional comma-separated user IDs filter.
startDatestring
Required start date (YYYY-MM-DD).
endDatestring
Required end date (YYYY-MM-DD), must be >= startDate and within 31 days.
cursorinteger
Optional zero-based user offset for pagination.
limitinteger
Optional page size. Supports up to 1000 results.
Response
Get Capacity Schedules