Meridyon Public API

A read-only, versioned HTTP API for programmatically pulling published schedule and on-call data. All responses are JSON.

Authentication

Every request requires a per-org API key, sent as a bearer token:

curl https://schedule.meridyon.com/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.

Endpoints

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).

Published data only

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.

Versioning & deprecation

  • The API is versioned in the URL path (/api/v1/…). Breaking changes ship under a new version prefix (e.g. /api/v2); existing versions keep working.
  • Additive changes (new endpoints, new response fields) may land within a version without a version bump — clients should ignore unknown fields.
  • When a version is deprecated, it is announced here with a sunset date at least 6 months out. Deprecated responses include a Deprecation header during the window.

For AI agents

Building an agent or assistant that works with Meridyon? Start here.

  • Meridyon MCP server. Meridyon MCP server for your organization's agents — OAuth sign-in, read your published schedule, request time off and offer swaps through the normal approval flow. Endpoint: https://schedule.meridyon.com/api/mcp
    • Sign in with OAuth as the person using the agent; it acts with that person’s own Meridyon permissions.
    • Read that person’s published schedule.
    • Request time off and offer shift swaps; requests go through the same approval flow as the app.
  • OpenAPI spec. The read-only REST API above, machine-readable: https://schedule.meridyon.com/api/v1/openapi.json
  • llms.txt. Curated product, pricing, and security facts for agents: https://schedule.meridyon.com/llms.txt (long form: https://schedule.meridyon.com/llms-full.txt)

Machine-readable spec

The full OpenAPI 3.1 description is available as JSON:

/api/v1/openapi.json