Skip to main content

Healos External API

The Healos External API lets you programmatically manage patients, documents, and appointments in your Healos account.

Base URL

All API requests are made to:
https://api.healos.ai/ext-api/v1

Quick Start

  1. Get an API key from the Healos dashboard.
  2. Make your first request:
curl -H "X-API-Key: hlsk_your_key_here" \
  https://api.healos.ai/ext-api/v1/patients
  1. Explore the API Reference tab for all endpoints.

Resources

Authentication

API keys, scopes, and security

Rate Limiting

Request limits and best practices

Error Handling

Error response format and status codes

Available Resources

ResourceDescription
PatientsCreate, read, update, and delete patient records
DocumentsUpload, list, and delete patient documents (PDF, images, DOCX)
AppointmentsManage appointments with scheduling, recurrence, and status tracking