The Scheduler API is an external Go service that runs the same automatic volunteer-to-shift assignment engine that powers the Shift Scheduler web app. You can call it directly from your own application to schedule any set of volunteers and shifts, receive a fairness-scored result, and surface any conflicts.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/greenmartialarts/shift-scheduler-web/llms.txt
Use this file to discover all available pages before exploring further.
This is an external API hosted separately from the Shift Scheduler web app. To get an API key, email arnav.shah.2k10@gmail.com.
Base URL
Endpoints
POST /api/schedule
Run the scheduling engine on a JSON payload of volunteers and shifts. Returns assignments, unfilled shifts, and a fairness score.
POST /api/schedule/csv
Same scheduling engine, but accepts CSV files via multipart/form-data instead of JSON.
POST /api/validate
Validate your request payload without running the scheduler. Use this to debug data format issues before submitting.
GET /api/usage
Retrieve your current API quota and usage history.
Endpoint summary
| Method | Path | Description |
|---|---|---|
POST | /api/schedule | Run the scheduler with a JSON body |
POST | /api/schedule/csv | Run the scheduler with CSV file uploads |
POST | /api/validate | Validate a request payload |
GET | /api/usage | Check quota and usage history |
Authentication
All requests require an HMAC-signed API key passed in theAuthorization header: