LIlimblecmms
Routes
Users
Capacity
Schedules

Get Capacity Schedules

Changed on

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

Request

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

locationsinteger[]

Changes

  • 488d795f846fRevision changes
    • warning

      for the query request parameter limit, the max was set to 1000.00

    • warning

      for the query request parameter limit, the min was set to 1.00

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status