The practitioner object

string

The practitioner's unique identifier.

Example:

"pra_01HQFQ9QWTNNPY58FZ8CB3FWWK"

online_appointment_booking

boolean | null

Whether online appointment booking is enabled for this practitioner.

Example:

true

service_ids

string[]

The IDs of services provided by this practitioner.

Example:

[
  "ser_01HYHYQHA682J0K1RW7B2HVA9F",
  "ser_01HYHYW37MTYJPMT5JV4RN99GK"
]

location_ids

string[]

The IDs of locations where this practitioner works.

Example:

[
  "loc_01HYHYQHA682J0K1RW7B2HVA9F",
  "loc_01HYHYW37MTYJPMT5JV4RN99GK"
]

provider_numbers

object[]

The practitioner's provider numbers for different locations.

Show child attributes

Example:

[
  {
    "id": "prn_01HQR12PABCD1234EFGH56789",
    "location_id": "loc_01HQFQ9QWTNNPY58FZ8CB3FWWK",
    "type": "medicare",
    "number": "123456A"
  }
]

created_at

string

The timestamp when the practitioner was created (ISO 8601).

Example:

"2024-01-01T12:00:00Z"

List all practitioners

{
  "id": "<string>",
  "online_appointment_booking": true,
  "service_ids": [
    "<string>"
  ],
  "location_ids": [
    "<string>"
  ],
  "provider_numbers": [
    {
      "id": "<string>",
      "location_id": "<string>",
      "type": "<string>",
      "number": "<string>"
    }
  ],
  "created_at": "<string>"
}

API documentation

Appointment Clients

Appointments

Availabilities

Availability Slots

Busy Times

Clients

Contacts

Form Templates

Forms

Locations

Practitioners

Services