Skip to main content
GET
List appointments
By default only real appointments are returned. Use 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

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Query Parameters

start_date
string<date>

Start of the date range (YYYY-MM-DD).

Example:

"2026-06-15"

end_date
string<date>

End of the date range (YYYY-MM-DD).

Example:

"2026-06-15"

patient_mrn
string

Filter by patient MRN.

Example:

"12345"

patient_phone
string

Filter by patient phone.

Example:

"555-123-4567"

patient_dob
string<date>

Filter by patient date of birth (YYYY-MM-DD).

Example:

"1980-01-15"

patient_name
string

Filter by patient name.

Example:

"Jane Doe"

include_note
enum<string>

Include the appointment note in each result.

Available options:
true,
false
appointment_mode
string

Appointment mode filter.

category
string

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.

Example:

"appointment,schedule_slot"

include_schedule_blocks
enum<string>
deprecated

Deprecated. Use category instead. When true, schedule blocks are included alongside real appointments (equivalent to category='appointment,schedule_block'). Ignored when category is supplied.

Available options:
true,
false
status
string

Filter by appointment status.

provider_ehr_id
string

Filter by rendering provider EMR ID.

Example:

"provider-123"

location_ehr_id
string

Filter by location EMR ID.

Example:

"location-1"

appointment_type
string

Filter by visit type.

Example:

"NP"

secondary_provider_ehr_id
string

Filter by secondary provider EMR ID.

Example:

"provider-456"

emr_appointment_id
string

Look up a single appointment by its EMR appointment ID (makes start_date / end_date optional).

Example:

"appt-emr-789"

Response

Appointments for the account

success
boolean
required
appointments
object[]
required
warnings
string[]