Skip to main content
GET
/
v1
/
waitlist
cURL
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

​
Authorization
string
header
required

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

Response

Waitlist response

  • Option 1
  • Option 2
​
patient_id
string
Example:

"123456789"

​
healthie_patient_id
string
Example:

"123456789"

​
first_name
string
Example:

"John"

​
last_name
string
Example:

"Doe"

​
provider_ids
string[]
Example:
["1234", "5678"]
​
provider_names
string[]
Example:
["Provider 1", "Provider 2"]
​
available_dates
(string | object)[]
Example:
[
  "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
string[]
Example:
["1234", "5678"]
​
appointment_type_names
string[]
Example:
["Appointment Type 1", "Appointment Type 2"]
​
group_id
string
Example:

"1234567890"

​
group_name
string
Example:

"Group Name"