Skip to main content

Schedule API

The Schedule API provides week-level operations for managing staff scheduling.

What You Can Do​

  • Copy a week — Duplicate all shifts from one week to another
  • Templates — Save a week's schedule as a reusable template, then load it onto any future week
  • Insights — Get per-day staffing totals and shift counts for a week
  • Demand — See booking volumes per day to compare against staffing levels
  • Understaffing warnings — Identify days where bookings exceed available staff hours

Base Path​

All schedule endpoints are prefixed with /v1/staff/schedule.

Authentication​

All endpoints require a bearer API key. Read operations require staff:read; write operations require staff:write.