Skip to main content
GET
/
appointments
List appointments
curl --request GET \
  --url https://api.healos.ai/ext-api/v1/appointments \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "patient_id": "1743552000000",
      "patient_name": "Maria Santos",
      "appointment_type": "Initial Evaluation",
      "visit_type": "Telehealth",
      "start_at": "2026-04-15T14:00:00.000Z",
      "duration_minutes": 50,
      "notes": "New patient intake. Please complete forms beforehand.",
      "status": "SCHEDULED",
      "created_at": "2026-04-01T10:00:00.000Z",
      "updated_at": "2026-04-01T10:00:00.000Z",
      "repeat_rule": {
        "frequency": "WEEKLY",
        "interval": 1,
        "end_date": "2026-07-15"
      },
      "external_id": "PARTNER-APPT-789"
    }
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "total_pages": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.healos.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API key obtained from /api/v1/ext-api-keys

Query Parameters

​
page
string
default:1
Example:

"1"

​
limit
string
default:20
Example:

"20"

​
date
string

Filter by date (YYYY-MM-DD)

Example:

"2026-04-15"

​
start_date
string

Filter start date (YYYY-MM-DD)

Example:

"2026-04-01"

​
end_date
string

Filter end date (YYYY-MM-DD)

Example:

"2026-04-30"

​
external_id
string

Look up a single appointment by caller-supplied external_id (bypasses pagination).

Example:

"PARTNER-APPT-789"

Response

List of appointments

​
data
object[]
required
​
meta
object
required