API Documentation
Variables
Outcomes
Agents
Patients
Waitlist
Waitlist Runs
Waitlist
Get Waitlist
Get the list of patients on the waitlist
GET
/
v1
/
waitlist
curl --request GET \
--url https://api.penciled.com/v1/waitlist \
--header 'Authorization: Bearer <token>'
[
{
"patient_id": "123456789",
"healthie_patient_id": "123456789",
"first_name": "John",
"last_name": "Doe",
"provider_ids": [
"1234",
"5678"
],
"provider_names": [
"Provider 1",
"Provider 2"
],
"available_dates": [
"2024-12-05T00:00:00.000-08:00",
{
"startDate": "2024-12-05T09:00:00.000-08:00",
"endDate": "2024-12-05T12:00:00.000-08:00"
}
],
"appointment_type_ids": [
"1234",
"5678"
],
"appointment_type_names": [
"Appointment Type 1",
"Appointment Type 2"
],
"group_id": "1234567890",
"group_name": "Group Name"
}
]
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200
application/json
Waitlist response
curl --request GET \
--url https://api.penciled.com/v1/waitlist \
--header 'Authorization: Bearer <token>'
[
{
"patient_id": "123456789",
"healthie_patient_id": "123456789",
"first_name": "John",
"last_name": "Doe",
"provider_ids": [
"1234",
"5678"
],
"provider_names": [
"Provider 1",
"Provider 2"
],
"available_dates": [
"2024-12-05T00:00:00.000-08:00",
{
"startDate": "2024-12-05T09:00:00.000-08:00",
"endDate": "2024-12-05T12:00:00.000-08:00"
}
],
"appointment_type_ids": [
"1234",
"5678"
],
"appointment_type_names": [
"Appointment Type 1",
"Appointment Type 2"
],
"group_id": "1234567890",
"group_name": "Group Name"
}
]
Assistant
Responses are generated using AI and may contain mistakes.