Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

waitlist_run_id
string

The ID of the waitlist run, please use either this or the start and end date

start_date
string<date-time>

The start date of the created_at to filter by in ISO format: 2024-12-03T00:00:00.000-08:00

end_date
string<date-time>

The end date of the created_at to filter by in ISO format: 2024-12-05T00:00:00.000-08:00

Response

Waitlist run response

waitlist_run_id
string
Example:

"123456789"

appointment_date
string
Example:

"2024-12-09T11:15:00.000-08:00"

state
string
Example:

"accepted"

state_justification
string
Example:

"Patient accepted appointment"

expiration_date
string
Example:

"2024-12-09T11:00:00.000-08:00"

time_to_fill_minutes
integer
Example:

12

created_at
string
Example:

"2024-12-09T11:00:00.000-08:00"

ehr_patient_id
string
Example:

"123456789"

ehr_appt_type_id
string
Example:

"1234"

appointment_type_name
string
Example:

"Appointment Type Name"

ehr_provider_id
string
Example:

"5678"

provider_first_name
string
Example:

"Provider First Name"

provider_last_name
string
Example:

"Provider Last Name"

location
string
Example:

"Location Name"

booked_by_first_name
string
Example:

"John"

booked_by_last_name
string
Example:

"Doe"

booked_by_phone_number
string
Example:

"1234567890"

booked_by_email
string
Example:

"john.doe@example.com"