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,
"provider_id": "aaaaaaa1-0000-0000-0000-000000000001",
"notes": "New patient intake. Please complete forms beforehand.",
"status": "SCHEDULED",
"external_id": "PARTNER-APPT-789"
}
'import requests
url = "https://api.healos.ai/ext-api/v1/appointments"
payload = {
"patient_id": "1743552000000",
"appointment_type": "Initial Evaluation",
"visit_type": "Telehealth",
"start_at": "2026-04-15T14:00:00.000Z",
"duration_minutes": 50,
"provider_id": "aaaaaaa1-0000-0000-0000-000000000001",
"notes": "New patient intake. Please complete forms beforehand.",
"status": "SCHEDULED",
"external_id": "PARTNER-APPT-789"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patient_id: '1743552000000',
appointment_type: 'Initial Evaluation',
visit_type: 'Telehealth',
start_at: '2026-04-15T14:00:00.000Z',
duration_minutes: 50,
provider_id: 'aaaaaaa1-0000-0000-0000-000000000001',
notes: 'New patient intake. Please complete forms beforehand.',
status: 'SCHEDULED',
external_id: 'PARTNER-APPT-789'
})
};
fetch('https://api.healos.ai/ext-api/v1/appointments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.healos.ai/ext-api/v1/appointments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'patient_id' => '1743552000000',
'appointment_type' => 'Initial Evaluation',
'visit_type' => 'Telehealth',
'start_at' => '2026-04-15T14:00:00.000Z',
'duration_minutes' => 50,
'provider_id' => 'aaaaaaa1-0000-0000-0000-000000000001',
'notes' => 'New patient intake. Please complete forms beforehand.',
'status' => 'SCHEDULED',
'external_id' => 'PARTNER-APPT-789'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.healos.ai/ext-api/v1/appointments"
payload := strings.NewReader("{\n \"patient_id\": \"1743552000000\",\n \"appointment_type\": \"Initial Evaluation\",\n \"visit_type\": \"Telehealth\",\n \"start_at\": \"2026-04-15T14:00:00.000Z\",\n \"duration_minutes\": 50,\n \"provider_id\": \"aaaaaaa1-0000-0000-0000-000000000001\",\n \"notes\": \"New patient intake. Please complete forms beforehand.\",\n \"status\": \"SCHEDULED\",\n \"external_id\": \"PARTNER-APPT-789\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.healos.ai/ext-api/v1/appointments")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patient_id\": \"1743552000000\",\n \"appointment_type\": \"Initial Evaluation\",\n \"visit_type\": \"Telehealth\",\n \"start_at\": \"2026-04-15T14:00:00.000Z\",\n \"duration_minutes\": 50,\n \"provider_id\": \"aaaaaaa1-0000-0000-0000-000000000001\",\n \"notes\": \"New patient intake. Please complete forms beforehand.\",\n \"status\": \"SCHEDULED\",\n \"external_id\": \"PARTNER-APPT-789\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.healos.ai/ext-api/v1/appointments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patient_id\": \"1743552000000\",\n \"appointment_type\": \"Initial Evaluation\",\n \"visit_type\": \"Telehealth\",\n \"start_at\": \"2026-04-15T14:00:00.000Z\",\n \"duration_minutes\": 50,\n \"provider_id\": \"aaaaaaa1-0000-0000-0000-000000000001\",\n \"notes\": \"New patient intake. Please complete forms beforehand.\",\n \"status\": \"SCHEDULED\",\n \"external_id\": \"PARTNER-APPT-789\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"patient_id": "1743552000000",
"patient_name": "Maria Santos",
"provider_id": "aaaaaaa1-0000-0000-0000-000000000001",
"provider_name": "Dr. Alice Nguyen",
"provider_npi": "1234567890",
"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"
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "external_id already in use",
"existing": {
"id": "<string>",
"external_id": "<string>"
}
}{
"error": "Rate limit exceeded. Please retry after the window resets."
}Appointments
Create an appointment
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,
"provider_id": "aaaaaaa1-0000-0000-0000-000000000001",
"notes": "New patient intake. Please complete forms beforehand.",
"status": "SCHEDULED",
"external_id": "PARTNER-APPT-789"
}
'import requests
url = "https://api.healos.ai/ext-api/v1/appointments"
payload = {
"patient_id": "1743552000000",
"appointment_type": "Initial Evaluation",
"visit_type": "Telehealth",
"start_at": "2026-04-15T14:00:00.000Z",
"duration_minutes": 50,
"provider_id": "aaaaaaa1-0000-0000-0000-000000000001",
"notes": "New patient intake. Please complete forms beforehand.",
"status": "SCHEDULED",
"external_id": "PARTNER-APPT-789"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patient_id: '1743552000000',
appointment_type: 'Initial Evaluation',
visit_type: 'Telehealth',
start_at: '2026-04-15T14:00:00.000Z',
duration_minutes: 50,
provider_id: 'aaaaaaa1-0000-0000-0000-000000000001',
notes: 'New patient intake. Please complete forms beforehand.',
status: 'SCHEDULED',
external_id: 'PARTNER-APPT-789'
})
};
fetch('https://api.healos.ai/ext-api/v1/appointments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.healos.ai/ext-api/v1/appointments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'patient_id' => '1743552000000',
'appointment_type' => 'Initial Evaluation',
'visit_type' => 'Telehealth',
'start_at' => '2026-04-15T14:00:00.000Z',
'duration_minutes' => 50,
'provider_id' => 'aaaaaaa1-0000-0000-0000-000000000001',
'notes' => 'New patient intake. Please complete forms beforehand.',
'status' => 'SCHEDULED',
'external_id' => 'PARTNER-APPT-789'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.healos.ai/ext-api/v1/appointments"
payload := strings.NewReader("{\n \"patient_id\": \"1743552000000\",\n \"appointment_type\": \"Initial Evaluation\",\n \"visit_type\": \"Telehealth\",\n \"start_at\": \"2026-04-15T14:00:00.000Z\",\n \"duration_minutes\": 50,\n \"provider_id\": \"aaaaaaa1-0000-0000-0000-000000000001\",\n \"notes\": \"New patient intake. Please complete forms beforehand.\",\n \"status\": \"SCHEDULED\",\n \"external_id\": \"PARTNER-APPT-789\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.healos.ai/ext-api/v1/appointments")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patient_id\": \"1743552000000\",\n \"appointment_type\": \"Initial Evaluation\",\n \"visit_type\": \"Telehealth\",\n \"start_at\": \"2026-04-15T14:00:00.000Z\",\n \"duration_minutes\": 50,\n \"provider_id\": \"aaaaaaa1-0000-0000-0000-000000000001\",\n \"notes\": \"New patient intake. Please complete forms beforehand.\",\n \"status\": \"SCHEDULED\",\n \"external_id\": \"PARTNER-APPT-789\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.healos.ai/ext-api/v1/appointments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patient_id\": \"1743552000000\",\n \"appointment_type\": \"Initial Evaluation\",\n \"visit_type\": \"Telehealth\",\n \"start_at\": \"2026-04-15T14:00:00.000Z\",\n \"duration_minutes\": 50,\n \"provider_id\": \"aaaaaaa1-0000-0000-0000-000000000001\",\n \"notes\": \"New patient intake. Please complete forms beforehand.\",\n \"status\": \"SCHEDULED\",\n \"external_id\": \"PARTNER-APPT-789\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"patient_id": "1743552000000",
"patient_name": "Maria Santos",
"provider_id": "aaaaaaa1-0000-0000-0000-000000000001",
"provider_name": "Dr. Alice Nguyen",
"provider_npi": "1234567890",
"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"
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "external_id already in use",
"existing": {
"id": "<string>",
"external_id": "<string>"
}
}{
"error": "Rate limit exceeded. Please retry after the window resets."
}Authorizations
API key obtained from /api/v1/ext-api-keys
Body
application/json
Patient ID (numeric)
Pattern:
^\d+$Example:
"1743552000000"
Type of appointment
Example:
"Initial Evaluation"
Available options:
Telehealth, In-Person, Both, Other Example:
"Telehealth"
ISO 8601 datetime
Example:
"2026-04-15T14:00:00.000Z"
Duration in minutes
Required range:
x >= 1Example:
50
Optional internal provider id (see GET /providers) to assign this appointment to. Must be a provider in your organization. Defaults to the provider that owns the API key.
Minimum string length:
1Example:
"aaaaaaa1-0000-0000-0000-000000000001"
Example:
"New patient intake. Please complete forms beforehand."
Available options:
SCHEDULED, COMPLETED, CANCELLED, NO_SHOW Example:
"SCHEDULED"
Recurrence rule
Show child attributes
Show child attributes
Optional caller-supplied identifier. Unique per organization; immutable once set. Duplicate values return 409 with the existing record.
Required string length:
1 - 255Example:
"PARTNER-APPT-789"
Response
Appointment created
Show child attributes
Show child attributes
Was this page helpful?
⌘I

