Appointments
Query appointments with rich filters, read appointment reasons, and manage bookings.
- Resource
client.appointments- SOAP operations
- GetAppointments, GetAppointment, GetAppointmentReasons, CreateAppointment, CreateAppointmentReason, UpdateAppointment, UpdateAppointmentStatus, DeleteAppointment
- Flat methods
get_appointments,get_appointment,get_appointment_reasons- Default throttle
- 250 ms
Methods
client.appointments.list#
readasync list(*, practice_name=None, practice_id=None, start_date=None, end_date=None, patient_id=None, patient_full_name=None, confirmation_status=None, resource_name=None, service_location_name=None, appointment_reason=None, appointment_type=None, patient_case_payer_scenario=None, timezone_offset_from_gmt=None, from_created_date=None, to_created_date=None, from_last_modified_date=None, to_last_modified_date=None, fields=None, extra_filter=None) -> list[dict]Query appointments using GetAppointments. Accepts practice_name or practice_id (resolved to the exact name). Date-only start_date and end_date expand to UTC day boundaries: 00:00:00Z through 23:59:59Z.
| Parameter | Type | Description |
|---|---|---|
practice_name | str | None | Practice name filter. |
practice_id | int | str | None | Practice ID; resolved to PracticeName automatically. |
start_date | str | date | datetime | None | Start of the appointment window. |
end_date | str | date | datetime | None | End of the appointment window. |
patient_id | int | str | None | Filter by patient ID (sent as a string). |
patient_full_name | str | None | Filter by patient full name. |
confirmation_status | str | None | Confirmation status filter. |
resource_name | str | None | Resource name filter. |
service_location_name | str | None | Service location name filter. |
appointment_reason | str | None | Appointment reason filter. |
appointment_type | str | None | Appointment type filter. |
patient_case_payer_scenario | str | None | Case payer scenario filter. |
timezone_offset_from_gmt | str | None | Timezone offset string. |
from_created_date | str | date | datetime | None | Lower creation-date bound. |
to_created_date | str | date | datetime | None | Upper creation-date bound. |
from_last_modified_date | str | date | datetime | None | Lower last-modified bound. |
to_last_modified_date | str | date | datetime | None | Upper last-modified bound. |
fields | Iterable[str] | Mapping[str, bool] | None | Field selector. |
extra_filter | Mapping[str, Any] | None | Additional raw Filter keys. |
list[dict[str, Any]]appointments = await client.appointments.list(
practice_id=7,
start_date="2026-04-01",
end_date="2026-04-16",
)client.appointments.get#
readasync get(appointment_id) -> dict | NoneFetch detailed appointment data by numeric AppointmentId using GetAppointment. Returns None when not found.
| Parameter | Type | Description |
|---|---|---|
appointment_idrequired | int | Numeric appointment ID. |
dict[str, Any] | Noneclient.appointments.list_reasons#
readasync list_reasons(practice_id) -> list[dict]List appointment reasons configured for a practice using GetAppointmentReasons.
| Parameter | Type | Description |
|---|---|---|
practice_idrequired | int | Practice ID. |
list[dict[str, Any]]client.appointments.create#
writeasync create(appointment) -> dictCreate a new appointment using CreateAppointment. Blocked when read_only=True.
| Parameter | Type | Description |
|---|---|---|
appointmentrequired | Mapping[str, Any] | Raw Appointment payload. |
dict[str, Any] (the created appointment or raw response)client.appointments.create_reason#
writeasync create_reason(appointment_reason) -> dictCreate an appointment reason using CreateAppointmentReason. Blocked when read_only=True.
| Parameter | Type | Description |
|---|---|---|
appointment_reasonrequired | Mapping[str, Any] | Raw AppointmentReason payload. |
dict[str, Any]client.appointments.update#
writeasync update(appointment) -> dictUpdate an existing appointment using UpdateAppointment. Blocked when read_only=True.
| Parameter | Type | Description |
|---|---|---|
appointmentrequired | Mapping[str, Any] | Raw Appointment payload including the ID. |
dict[str, Any]client.appointments.update_status#
writeasync update_status(appointment_id, status, *, ticket_number=None) -> dictUpdate an appointment's confirmation status using UpdateAppointmentStatus. Blocked when read_only=True.
| Parameter | Type | Description |
|---|---|---|
appointment_idrequired | int | Appointment ID. |
statusrequired | str | New appointment status. |
ticket_number | str | None | Optional ticket number. |
dict[str, Any]client.appointments.delete#
writeasync delete(appointment_id) -> dictDelete an appointment using DeleteAppointment. Blocked when read_only=True.
| Parameter | Type | Description |
|---|---|---|
appointment_idrequired | int | Appointment ID. |
dict[str, Any]Example
from datetime import date
appointments = await client.get_appointments(
practice_id=7,
start_date=date(2026, 4, 1),
end_date="2026-04-16",
)
reasons = await client.get_appointment_reasons(practice_id=7)
"2026-04-01" produces a full-day UTC window. Pass a datetime or a string with a time component when you need finer bounds.