Docs/ API Reference/ Scheduling API
v2.4.0

Scheduling API

Create, manage, and optimize employee schedules, shifts, and site assignments through the Scheduling API.

Internal API Documentation

Full API specifications are available in Swagger UI. This page provides an overview and quick reference.

Overview

The Scheduling API enables comprehensive shift management including creation, assignment, swapping, and AI-assisted optimization for workforce planning.

Shift Management

GET/api/v1/shifts

List all shifts with filtering by date range, site, and employee.

View in Swagger →
POST/api/v1/shifts

Create a new shift with employee assignment and site allocation.

View in Swagger →
POST/api/v1/shifts/bulk

Create multiple shifts in a single request for recurring schedules.

View in Swagger →

Schedule Templates

GET/api/v1/schedules/templates

List available schedule templates for quick deployment.

View in Swagger →
POST/api/v1/schedules/generate

Generate schedules from templates with AI optimization.

View in Swagger →

Shift Swaps & Requests

POST/api/v1/shifts/{id}/swap-request

Request a shift swap with another employee.

View in Swagger →
POST/api/v1/shifts/{id}/release

Release a shift for open claiming by available employees.

View in Swagger →

Resources

Swagger Documentation

Complete scheduling API specification

Code Examples

Scheduling integration samples
Previous← Employees API NextAttendance API →
ESC