Ttebra_soap_apiAsync Tebra SOAP 2.1
SOAP 2.1
Resources

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#

read
async 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.

Parameters
ParameterTypeDescription
practice_namestr | NonePractice name filter.
practice_idint | str | NonePractice ID; resolved to PracticeName automatically.
start_datestr | date | datetime | NoneStart of the appointment window.
end_datestr | date | datetime | NoneEnd of the appointment window.
patient_idint | str | NoneFilter by patient ID (sent as a string).
patient_full_namestr | NoneFilter by patient full name.
confirmation_statusstr | NoneConfirmation status filter.
resource_namestr | NoneResource name filter.
service_location_namestr | NoneService location name filter.
appointment_reasonstr | NoneAppointment reason filter.
appointment_typestr | NoneAppointment type filter.
patient_case_payer_scenariostr | NoneCase payer scenario filter.
timezone_offset_from_gmtstr | NoneTimezone offset string.
from_created_datestr | date | datetime | NoneLower creation-date bound.
to_created_datestr | date | datetime | NoneUpper creation-date bound.
from_last_modified_datestr | date | datetime | NoneLower last-modified bound.
to_last_modified_datestr | date | datetime | NoneUpper last-modified bound.
fieldsIterable[str] | Mapping[str, bool] | NoneField selector.
extra_filterMapping[str, Any] | NoneAdditional raw Filter keys.
Returnslist[dict[str, Any]]
Example
appointments = await client.appointments.list(
    practice_id=7,
    start_date="2026-04-01",
    end_date="2026-04-16",
)

client.appointments.get#

read
async get(appointment_id) -> dict | None

Fetch detailed appointment data by numeric AppointmentId using GetAppointment. Returns None when not found.

Parameters
ParameterTypeDescription
appointment_idrequiredintNumeric appointment ID.
Returnsdict[str, Any] | None

client.appointments.list_reasons#

read
async list_reasons(practice_id) -> list[dict]

List appointment reasons configured for a practice using GetAppointmentReasons.

Parameters
ParameterTypeDescription
practice_idrequiredintPractice ID.
Returnslist[dict[str, Any]]

client.appointments.create#

write
async create(appointment) -> dict

Create a new appointment using CreateAppointment. Blocked when read_only=True.

Parameters
ParameterTypeDescription
appointmentrequiredMapping[str, Any]Raw Appointment payload.
Returnsdict[str, Any] (the created appointment or raw response)

client.appointments.create_reason#

write
async create_reason(appointment_reason) -> dict

Create an appointment reason using CreateAppointmentReason. Blocked when read_only=True.

Parameters
ParameterTypeDescription
appointment_reasonrequiredMapping[str, Any]Raw AppointmentReason payload.
Returnsdict[str, Any]

client.appointments.update#

write
async update(appointment) -> dict

Update an existing appointment using UpdateAppointment. Blocked when read_only=True.

Parameters
ParameterTypeDescription
appointmentrequiredMapping[str, Any]Raw Appointment payload including the ID.
Returnsdict[str, Any]

client.appointments.update_status#

write
async update_status(appointment_id, status, *, ticket_number=None) -> dict

Update an appointment's confirmation status using UpdateAppointmentStatus. Blocked when read_only=True.

Parameters
ParameterTypeDescription
appointment_idrequiredintAppointment ID.
statusrequiredstrNew appointment status.
ticket_numberstr | NoneOptional ticket number.
Returnsdict[str, Any]

client.appointments.delete#

write
async delete(appointment_id) -> dict

Delete an appointment using DeleteAppointment. Blocked when read_only=True.

Parameters
ParameterTypeDescription
appointment_idrequiredintAppointment ID.
Returnsdict[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)
Date handlingPassing a date-only value such as "2026-04-01" produces a full-day UTC window. Pass a datetime or a string with a time component when you need finer bounds.

Related