API reference

The Orchestration API is how your systems read and write care-orchestration data (patients, care flows, activities, and more) over a single GraphQL endpoint.

Start with the guides, then use the operation reference for the domain you need.

Guides

• Getting started — make your first authenticated request.
• Authentication — obtain and send an API key.
• Environments — sandbox, production, and regions.
• Pagination — page and sort list results.
• Errors — read the code / success envelope and GraphQL errors.
• Rate limits — limits and backoff.
• Mutations — an orientation to the write API.
• Webhooks — receive, inspect, and retry webhook calls.

Reference

Operations are grouped by domain:

• Patients
• Care flows
• Activities
• Activity types
• Tracks
• Stakeholders
• Timers
• Hosted sessions & pages
• API calls & webhooks
• Subscriptions
• Tenant