Loading...
Loading...
Ask about the schedule, get how-to help, or tap “Show me” for a guided walkthrough.
A read-only, versioned HTTP API for programmatically pulling published schedule and on-call data. All responses are JSON.
Every request requires a per-org API key, sent as a bearer token:
curl https://<your-host>/api/v1/on-call \ -H "Authorization: Bearer mky_live_…"
Keys are minted by an org admin under Department Settings → Public API keys. A key is shown exactly once at creation and stored only as a hash — keep it safe. With no key (or a revoked one), every endpoint returns 401. Each key is scoped to the org that created it and exposes that org's published data only.
GET /api/v1/on-call
Current on-call roster
Published, scheduled shifts for the given date (default: today), each with its assigned provider. Optional query: date=YYYY-MM-DD.
GET /api/v1/schedule?start=…&end=…
Published shifts in a date range
Published, scheduled shifts within an inclusive [start, end] range (max 370 days). Both start and end are required (YYYY-MM-DD).
GET /api/v1/providers
Active provider roster
Active, non-slot providers for the org and its subdivisions. Directory fields only (id, name, email, role, pager, abbreviation).
The API returns only shifts whose schedule has been published. Draft / unpublished dates are never exposed, mirroring what providers see in their calendar feeds. Cancelled and deleted shifts are excluded.
/api/v1/…). Breaking changes ship under a new version prefix (e.g. /api/v2); existing versions keep working.Deprecation header during the window.The full OpenAPI 3.1 description is available as JSON: