v1

latestOpenAPI 3.0.02026-07-26550199.6 KB

practitioner

Get a single practitioner

Get practitioner data by id

get/practitioners/{id}

Path parameters

idinteger required

Example:1

Response

Object with practitioner data.

idinteger required

Practitioner id

firstnamestring required

Practitioner first name

lastnamestring required

Practitioner last name

emailstring email nullable required

Practitioner email

titlestring nullable required

Practitioner title

professionstring nullable required

Practitioner profession

isActiveboolean nullable

Whether the practitioner is active

descriptionstring nullable required

Practitioner description

roleNamestring required

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

onlineBookingboolean nullable

Whether online booking is enabled

timezonestring nullable

Practitioner timezone

archivedboolean nullable

Whether the practitioner has been archived

Example response

{
  "id": 1,
  "firstname": "Albus",
  "lastname": "Dumbledore",
  "title": "Dr",
  "profession": "Physiotherapist",
  "description": "Practitioner admin of Hogwarts",
  "roleName": "practitioner admin",
  "timezone": "Australia/Adelaide",
  "connections": [
    {
      "typeId": 1,
      "type": "Location"
    }
  ],
  "providerNumbers": [
    {
      "type": "Medicare",
      "number": "12345678",
      "locationId": 1
    }
  ]
}