Skip to main content
Get a single practitioner

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required
Required range: x > 0
Example:

1

Response

200 - application/json

Object with practitioner data.

id
integer
required

Practitioner id

Required range: x > 0
Example:

1

firstname
string
required

Practitioner first name

Example:

"Albus"

lastname
string
required

Practitioner last name

Example:

"Dumbledore"

email
string<email> | null
required

Practitioner email

title
string | null
required

Practitioner title

Example:

"Dr"

profession
string | null
required

Practitioner profession

Example:

"Physiotherapist"

description
string | null
required

Practitioner description

Example:

"Practitioner admin of Hogwarts"

roleName
string
required

Practitioner role name – can be one of the predefined roles or a custom user-defined role

Example:

"practitioner admin"

connections
object[]
required

Array of practitioner connections (locations/services) associated with this practitioner

providerNumbers
object[]
required
deletedAt
required

Object archived date time

Example:

"2023-07-30T09:00:00.000Z"

isActive
boolean | null
default:true

Whether the practitioner is active

onlineBooking
boolean | null
default:false

Whether online booking is enabled

timezone
string | null

Practitioner timezone

Example:

"Australia/Adelaide"

archived
boolean | null
default:false

Whether the practitioner has been archived

createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"