Ttebra_soap_apiAsync Tebra SOAP 2.1
SOAP 2.1
Resources

Providers

Query providers plus their working schedules, time-off blocks, and practice resource calendars.

Resource
client.providers
SOAP operations
GetProviders, GetProviderSchedules, GetProviderTimeOffs, GetPracticeResourceSchedules, GetPracticeResourceTimeOffs
Flat methods
get_providers, get_provider_schedules
Writes
None

Methods

client.providers.list#

read
async list(*, practice_id=None, practice_name=None, full_name=None, provider_type=None, department_name=None, active_only=False, exclude_referring=False, 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]

List providers using GetProviders. active_only and exclude_referring are applied client-side; when a list-style fields selector is used, Active and Type are added automatically so filtering remains correct.

Parameters
ParameterTypeDescription
practice_idint | str | NoneFilter by practice ID (sent as a string).
practice_namestr | NoneFilter by practice name.
full_namestr | NoneProvider full name filter.
provider_typestr | NoneProvider type filter (sent as Type).
department_namestr | NoneDepartment name filter.
active_onlyboolKeep only rows whose Active value is true. Default False.
exclude_referringboolDrop rows whose Type is Referring Provider. Default False.
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
providers = await client.get_providers(
    practice_id=7,
    active_only=True,
    exclude_referring=True,
)

client.providers.get_schedules#

read
async get_schedules(*, practice_id, provider_ids=None, start_datetime=None, end_datetime=None) -> list[dict]

Query provider schedules using GetProviderSchedules. Date-only bounds expand to UTC day boundaries.

Parameters
ParameterTypeDescription
practice_idrequiredintPractice ID.
provider_idsSequence[int] | NoneRestrict to these provider IDs.
start_datetimestr | date | datetime | NoneStart of the schedule window.
end_datetimestr | date | datetime | NoneEnd of the schedule window.
Returnslist[dict[str, Any]] (id key ScheduleId)

client.providers.get_time_offs#

read
async get_time_offs(*, practice_id, provider_ids=None, start_datetime=None, end_datetime=None) -> list[dict]

Query provider time-off blocks using GetProviderTimeOffs.

Parameters
ParameterTypeDescription
practice_idrequiredintPractice ID.
provider_idsSequence[int] | NoneRestrict to these provider IDs.
start_datetimestr | date | datetime | NoneStart of the window.
end_datetimestr | date | datetime | NoneEnd of the window.
Returnslist[dict[str, Any]] (id key TimeOffId)

client.providers.get_resource_schedules#

read
async get_resource_schedules(*, practice_id, resource_ids=None, start_datetime=None, end_datetime=None) -> list[dict]

Query practice resource schedules using GetPracticeResourceSchedules.

Parameters
ParameterTypeDescription
practice_idrequiredintPractice ID.
resource_idsSequence[int] | NoneRestrict to these resource IDs.
start_datetimestr | date | datetime | NoneStart of the window.
end_datetimestr | date | datetime | NoneEnd of the window.
Returnslist[dict[str, Any]] (id key ScheduleId)

client.providers.get_resource_time_offs#

read
async get_resource_time_offs(*, practice_id, resource_ids=None, start_datetime=None, end_datetime=None) -> list[dict]

Query practice resource time-off blocks using GetPracticeResourceTimeOffs.

Parameters
ParameterTypeDescription
practice_idrequiredintPractice ID.
resource_idsSequence[int] | NoneRestrict to these resource IDs.
start_datetimestr | date | datetime | NoneStart of the window.
end_datetimestr | date | datetime | NoneEnd of the window.
Returnslist[dict[str, Any]] (id key TimeOffId)

Example: weekly availability

providers = await client.get_providers(practice_id=7, active_only=True)
provider_ids = [p["ID"] for p in providers]

schedules, time_offs = await asyncio.gather(
    client.providers.get_schedules(
        practice_id=7,
        provider_ids=provider_ids,
        start_datetime="2026-04-13",
        end_datetime="2026-04-19",
    ),
    client.providers.get_time_offs(
        practice_id=7,
        provider_ids=provider_ids,
        start_datetime="2026-04-13",
        end_datetime="2026-04-19",
    ),
)
Client-side filtersactive_only and exclude_referring filter rows after retrieval. When you pass a list of field names, the resource adds Active and Type so the filters have data to inspect.

Related