curl --request GET \
--url https://api.usecobalt.com/v1/appointments \
--header 'access_token: <api-key>' \
--header 'client_id: <api-key>' \
--header 'client_secret: <api-key>'import requests
url = "https://api.usecobalt.com/v1/appointments"
headers = {
"client_id": "<api-key>",
"client_secret": "<api-key>",
"access_token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {client_id: '<api-key>', client_secret: '<api-key>', access_token: '<api-key>'}
};
fetch('https://api.usecobalt.com/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.usecobalt.com/v1/appointments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"access_token: <api-key>",
"client_id: <api-key>",
"client_secret: <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"
"net/http"
"io"
)
func main() {
url := "https://api.usecobalt.com/v1/appointments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("client_id", "<api-key>")
req.Header.Add("client_secret", "<api-key>")
req.Header.Add("access_token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.usecobalt.com/v1/appointments")
.header("client_id", "<api-key>")
.header("client_secret", "<api-key>")
.header("access_token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usecobalt.com/v1/appointments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["client_id"] = '<api-key>'
request["client_secret"] = '<api-key>'
request["access_token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"appointments": [
{
"id": "<string>",
"datetime": "2023-11-07T05:31:56Z",
"status": "<string>",
"reason": "<string>",
"schedule_block_label": "<string>",
"schedule_block_color": "<string>",
"note": "<string>",
"location": "<string>",
"appointment_type": "<string>",
"appointment_mode": "<string>",
"complaint_type": "<string>",
"duration": 123,
"ehr_appointment_id": "<string>",
"emr_appointment_id": "<string>",
"provider_ehr_id": "<string>",
"provider_name": "<string>",
"provider_npi": "<string>",
"secondary_provider_ehr_id": "<string>",
"patient_first_name": "<string>",
"patient_last_name": "<string>",
"patient_phone": "<string>",
"patient_name": "<string>",
"patient_mrn": "<string>",
"patient_ehr_id": "<string>",
"patient_dob": "<string>",
"patient_gender": "<string>",
"insurance": "<string>",
"insurances": [
{}
],
"insurance_subscriber": "<string>",
"insurance_number": "<string>",
"insurance_group_number": "<string>",
"secondary_insurance": "<string>",
"secondary_insurance_number": "<string>",
"diagnoses": [
{}
],
"medications": [
{}
],
"progress_note": "<string>",
"practice_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"object_metadata": {
"source": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
}
],
"warnings": [
"<string>"
]
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}Get Appointments
Gets a list of appointments.
curl --request GET \
--url https://api.usecobalt.com/v1/appointments \
--header 'access_token: <api-key>' \
--header 'client_id: <api-key>' \
--header 'client_secret: <api-key>'import requests
url = "https://api.usecobalt.com/v1/appointments"
headers = {
"client_id": "<api-key>",
"client_secret": "<api-key>",
"access_token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {client_id: '<api-key>', client_secret: '<api-key>', access_token: '<api-key>'}
};
fetch('https://api.usecobalt.com/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.usecobalt.com/v1/appointments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"access_token: <api-key>",
"client_id: <api-key>",
"client_secret: <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"
"net/http"
"io"
)
func main() {
url := "https://api.usecobalt.com/v1/appointments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("client_id", "<api-key>")
req.Header.Add("client_secret", "<api-key>")
req.Header.Add("access_token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.usecobalt.com/v1/appointments")
.header("client_id", "<api-key>")
.header("client_secret", "<api-key>")
.header("access_token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usecobalt.com/v1/appointments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["client_id"] = '<api-key>'
request["client_secret"] = '<api-key>'
request["access_token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"appointments": [
{
"id": "<string>",
"datetime": "2023-11-07T05:31:56Z",
"status": "<string>",
"reason": "<string>",
"schedule_block_label": "<string>",
"schedule_block_color": "<string>",
"note": "<string>",
"location": "<string>",
"appointment_type": "<string>",
"appointment_mode": "<string>",
"complaint_type": "<string>",
"duration": 123,
"ehr_appointment_id": "<string>",
"emr_appointment_id": "<string>",
"provider_ehr_id": "<string>",
"provider_name": "<string>",
"provider_npi": "<string>",
"secondary_provider_ehr_id": "<string>",
"patient_first_name": "<string>",
"patient_last_name": "<string>",
"patient_phone": "<string>",
"patient_name": "<string>",
"patient_mrn": "<string>",
"patient_ehr_id": "<string>",
"patient_dob": "<string>",
"patient_gender": "<string>",
"insurance": "<string>",
"insurances": [
{}
],
"insurance_subscriber": "<string>",
"insurance_number": "<string>",
"insurance_group_number": "<string>",
"secondary_insurance": "<string>",
"secondary_insurance_number": "<string>",
"diagnoses": [
{}
],
"medications": [
{}
],
"progress_note": "<string>",
"practice_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"object_metadata": {
"source": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
}
],
"warnings": [
"<string>"
]
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}category to include schedule slots and blocks, for example ?category=appointment,schedule_slot or ?category=schedule_slot for open availability only.
The legacy include_schedule_blocks=true parameter is deprecated but still honored: it is equivalent to ?category=appointment,schedule_block. Prefer category, which also supports schedule slots. category takes precedence if both are supplied.Authorizations
Query Parameters
Start of the date range (YYYY-MM-DD).
"2026-06-15"
End of the date range (YYYY-MM-DD).
"2026-06-15"
Filter by patient MRN.
"12345"
Filter by patient phone.
"555-123-4567"
Filter by patient date of birth (YYYY-MM-DD).
"1980-01-15"
Filter by patient name.
"Jane Doe"
Include the appointment note in each result.
true, false Appointment mode filter.
Comma-separated allowlist of Cobalt record categories to return: 'appointment' (real appointments), 'schedule_slot' (open availability), 'schedule_block' (blocked time). Any subset is allowed, e.g. 'schedule_slot,schedule_block'. Distinct from appointment_type (the EHR visit type). Defaults to 'appointment' when omitted.
"appointment,schedule_slot"
Deprecated. Use category instead. When true, schedule blocks are included alongside real appointments (equivalent to category='appointment,schedule_block'). Ignored when category is supplied.
true, false Filter by appointment status.
Filter by rendering provider EMR ID.
"provider-123"
Filter by location EMR ID.
"location-1"
Filter by visit type.
"NP"
Filter by secondary provider EMR ID.
"provider-456"
Look up a single appointment by its EMR appointment ID (makes start_date / end_date optional).
"appt-emr-789"