API

Schedules

Read planned shifts for a date range.

Read planned shifts for a date range (roster / schedule grid).

Requires enableShifts on the company.

GET /api/v1/companies/{companyId}/schedules/shifts?startDate={yyyy-MM-dd}&endDate={yyyy-MM-dd}
Authorization: Bearer {token}
Query Required Description
startDate Yes Inclusive start
endDate Yes Inclusive end

Roles: employee, manager, owner, accountant

Example response

{
  "success": true,
  "data": [
    {
      "id": "…",
      "employeeId": "…",
      "employeeDisplayName": "John Smith",
      "shiftTypeName": "Day shift",
      "shiftTypeColorHex": "#3b82f6",
      "projectId": null,
      "startTime": "2026-08-25T08:00:00Z",
      "endTime": "2026-08-25T16:00:00Z",
      "isAdvertised": false,
      "isVirtualRuleSlot": false
    }
  ],
  "errors": null
}

Key fields

Field Description
startTime / endTime Shift interval (ISO-8601)
employeeId Assigned employee — null if open shift
isAdvertised Open for employee applications
isVirtualRuleSlot Display-only slot from calculation rule

Period summary (optional)

GET /api/v1/companies/{companyId}/schedules/summary?startDate={yyyy-MM-dd}&endDate={yyyy-MM-dd}

Not in public API v1

  • Create/update/delete shifts
  • Apply / release / swap workflows