Skip to main content
POST
/
appointments
Create an appointment
curl --request POST \
  --url https://api.healos.ai/ext-api/v1/appointments \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "patient_id": "1743552000000",
  "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",
  "external_id": "PARTNER-APPT-789"
}
'
{
  "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"
  }
}

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

Body

application/json
​
patient_id
string
required

Patient ID

Example:

"1743552000000"

​
appointment_type
string
required

Type of appointment

Example:

"Initial Evaluation"

​
visit_type
enum<string>
required
Available options:
Telehealth,
In-Person,
Both,
Other
Example:

"Telehealth"

​
start_at
string
required

ISO 8601 datetime

Example:

"2026-04-15T14:00:00.000Z"

​
duration_minutes
number
required

Duration in minutes

Required range: x >= 1
Example:

50

​
notes
string
Example:

"New patient intake. Please complete forms beforehand."

​
status
enum<string>
default:SCHEDULED
Available options:
SCHEDULED,
COMPLETED,
CANCELLED,
NO_SHOW
Example:

"SCHEDULED"

​
repeat_rule
object

Recurrence rule

​
external_id
string

Optional caller-supplied identifier. Unique per organization; immutable once set. Duplicate values return 409 with the existing record.

Required string length: 1 - 255
Example:

"PARTNER-APPT-789"

Response

Appointment created

​
data
object
required