Plugin API v0.1.0

Smart Roster Pro Plugin API

Integrate intelligent roster optimization directly into your application. Submit constraints, get optimized schedules, and export in the format you need.

Open Swagger UI Get API Key

Fast Optimization

Submit constraints and get an optimized roster in seconds, powered by the CP-SAT solver.

Bearer Token Auth

Secure API access with Bearer token authentication on all protected endpoints.

Multiple Export Formats

Export results as Deputy CSV, Tanda CSV, or Excel. Ready for import into your platform.

Quick Start

Make your first API call

Send a POST request to the optimize endpoint with your employees, shifts, and constraints. The solver will return an optimized roster assignment.

Terminal

# Optimize a roster
curl -X POST https://api.smartrosterpro.com/api/v1/optimize \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "employees": [
      {
        "id": "emp_1",
        "name": "Alice",
        "max_hours": 38,
        "availability": {
          "monday": ["morning", "afternoon"],
          "tuesday": ["morning"],
          "wednesday": ["morning", "afternoon", "evening"]
        }
      },
      {
        "id": "emp_2",
        "name": "Bob",
        "max_hours": 25,
        "availability": {
          "monday": ["afternoon", "evening"],
          "thursday": ["morning", "afternoon"],
          "friday": ["morning", "afternoon", "evening"]
        }
      }
    ],
    "shifts": [
      { "id": "morning", "start": "06:00", "end": "14:00" },
      { "id": "afternoon", "start": "14:00", "end": "22:00" },
      { "id": "evening", "start": "22:00", "end": "06:00" }
    ],
    "week_start": "2026-03-23"
  }'

The API returns an optimized assignment mapping each employee to their shifts, along with fairness metrics and total hours. Export the result to Deputy CSV, Tanda CSV, or Excel using the export endpoints.

API Reference

Endpoints

All authenticated endpoints require a Bearer token in the Authorization header.

GET/api/healthHealth check and API status

POST/api/optimizeGenerate an optimized roster from constraints

GET/api/optimize/{id}/export/deputyExport roster as Deputy-compatible CSV

GET/api/optimize/{id}/export/tandaExport roster as Tanda-compatible CSV

GET/api/optimize/{id}/export/excelExport roster as Excel spreadsheet

Authentication

Include your API key as a Bearer token in the Authorization header:

Authorization: Bearer your_api_key_here

Export Formats

Deputy CSV

Compatible with Deputy bulk import

Tanda CSV

Compatible with Tanda roster import

Excel (.xlsx)

Formatted spreadsheet with shift details

Ready to integrate?

Explore the full API documentation in our interactive Swagger UI, or sign up to get your API key.

Open Swagger UI Get API Key

Production Swagger UI: https://api.smartrosterpro.com/docs