Skip to main content
GET
Get Appointments

Authorizations

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

Query Parameters

start_date
string<date>

The start of the date range (ISO 8601 format). Required unless emr_appointment_id is provided.

end_date
string<date>

The end of the date range (ISO 8601 format). Required unless emr_appointment_id is provided.

patient_mrn
string

The mrn of the patient to filter appointments by

patient_name
string

The name of the patient to filter appointments by (case-insensitive, partial match)

patient_phone
string

The phone number of the patient to filter appointments by

status
string

Only include appointments with the given status

include_note
enum<string>

Indicate whether progress notes should be included when available

Available options:
true,
false
include_schedule_blocks
enum<string>

Indicate whether schedule blocks (eg. Lunch Break) should be included

Available options:
true,
false
appointment_mode
enum<string>

Filter by office or telemedicine appointments

Available options:
office,
telemedicine
provider_ehr_id
string

Filter appointments by provider EHR ID

location_ehr_id
string

Filter appointments by location EHR ID

appointment_type
string

Filter appointments by appointment type (e.g., "New Patient", "Follow Up", "Annual Checkup")

secondary_provider_ehr_id
string

Filter appointments by secondary provider EHR ID

emr_appointment_id
string

Filter appointments by EMR appointment ID. When provided, start_date and end_date are not required and the matching appointment is returned directly.

Response

200 - application/json

Successful response

success
boolean
appointments
object[]