Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
practitioner

Get a paged array of practitioners

Get a paged array of practitioners

get/practitioners

Query parameters

id_gtinteger nullable

The starting object id of the next page

Example:200
id_ltinteger nullable

The starting object id of the previous page

Example:100
string
OR
string
string
OR
string
include_archived'true' | 'false' nullable

Whether archived objects should be retrieved, default is false

firstnamestring nullable

Practitioner first name

Example:Albus
lastnamestring nullable

Practitioner last name

Example:Dumbledore
emailstring nullable

Patient email

Example:albus@hogwarts.edu
isActive'true' | 'false' nullable

Whether the practitioner is active

Example:true
roleNamestring nullable

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

Example:practitioner admin

Response

A paged array of practitioners

Example response

{
  "data": [
    {
      "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
        }
      ]
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}