Authorizations

Authorization
string
headerrequired

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

Query Parameters

id_gt
integer | null

The starting object id of the next page

id_lt
integer | null

The starting object id of the previous page

update_gt

Search for objects updated after this date time

update_lt

Search for objects updated before this date time

include_archived
enum<string> | null
default: false

Whether archived objects should be retrieved, default is false

Available options:
true,
false
firstname
string | null

Practitioner first name

lastname
string | null

Practitioner last name

email
string | null

Patient email

isActive
enum<string> | null

Whether the practitioner is active

Available options:
true,
false
roleName
enum<string> | null

Practitioner role name

Available options:
practitioner admin,
practitioner,
accountant,
practice manager,
receptionist

Response

200 - application/json
data
object[]
required
links
object
required