Teams integrating with healthcare platforms need stable schemas, clear change visibility, and documentation that reflects production behavior.

Healthie exposes a single GraphQL API that is used by both external developers and Healthie’s own web and mobile applications. There is no separate public or internal API layer, and no reduced or read-only surface. The schema, behavior, and release lifecycle are consistent across all consumers.

Recent updates to Healthie’s API documentation focus on improving schema transparency, change tracking, and support for AI- and agent-based development workflows.

Powered by GraphQL, Used in Production

Healthie’s API is built on GraphQL and provides full access to the platform: EHR, scheduling, engagement, telehealth, insurance billing, provider management, and more. It’s the same API our internal teams use every day to ship features across our web and mobile platform.

What this means for developers building to Healthie’s API: 

• Full parity with the product UI – if it exists in Healthie, it’s available via the API.
• Strong backwards compatibility – schema changes are additive wherever possible.
• Flexible querying – clients control exactly what data they fetch and mutate.
• Language-agnostic consumption – build in whatever stack fits your product.

A Weekly, Automated API Changelog

We’ve added an automated API changelog to our documentation. Every Friday, we generate a changelog entry that captures all GraphQL schema changes made during the prior week.

What this gives developers:

• Granular insight into schema evolution, not just major announcements
• Clear tracking of new fields, mutations, and deprecations
• Predictable cadence for reviewing changes as part of regular maintenance

We’ve also retroactively backfilled changelog entries for the past 12 months. These were generated after the fact, so there may be minor discrepancies, but the goal is to provide historical context — not just forward-looking updates.

AI- and Agent-Friendly Documentation

Teams building on Healthie are already using LLMs and agents as part of their development workflows: query generation, schema exploration, integration scaffolding, debugging, and automation.

To support this, the API Docs now provide:

• Direct Markdown export for every page
• Native Markdown page views
• One-click sending of docs URLs to tools like ChatGPT and Claude

This allows teams to ground AI agents and assistants in Healthie’s actual schema and documentation, enabling more reliable query generation, agent workflows, and integration development without manual copying or reformatting.

We’re exploring: Chat within API Docs

We are evaluating an AI chat interface within the API Docs that would allow developers to ask natural-language questions and receive answers based on Healthie’s documentation and GraphQL schema.

Example queries include:

• How to create a client and schedule an appointment
• Required fields for submitting an insurance claim
• Mutations related to provider availability

This work is exploratory and focused on improving discoverability and navigation of the existing API surface.

Walk through how to navigate our API docs: 

API Design and Operating Characteristics

An API is defined not just by available endpoints, but by its behavior under load, its change management model, and its consistency over time.

Healthie’s API is the same GraphQL API used by Healthie’s web and mobile applications and operates at production scale:

• Billions of API calls processed monthly
• High concurrent request volume across millions of active users
• Typical response times in the 300–500 ms range, depending on query complexity
• Backwards-compatible schema evolution by default
• Enterprise SLAs available for production usage

Sandbox (staging) environments are available for development and testing. Sandbox is isolated from production, does not allow PHI, and may exhibit higher latency or limited third-party integrations.

Recent API Docs updates—weekly schema changelogs, Markdown-first documentation, and exploration of schema-grounded AI navigation—are intended to make the API’s behavior, evolution, and surface area easier to inspect and reason about.

Documentation is available at https://docs.gethealthie.com/.