Skip to main content
Get a paged array of practitioners
curl --request GET \
  --url https://api.splose.com/v1/practitioners \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "firstname": "Albus",
      "lastname": "Dumbledore",
      "email": "jsmith@example.com",
      "title": "Dr",
      "profession": "Physiotherapist",
      "description": "Practitioner admin of Hogwarts",
      "roleName": "practitioner admin",
      "connections": [
        {
          "typeId": 1,
          "type": "Location"
        }
      ],
      "providerNumbers": [
        {
          "type": "Medicare",
          "number": "12345678",
          "locationId": 1
        }
      ],
      "deletedAt": "2023-07-30T09:00:00.000Z",
      "isActive": true,
      "onlineBooking": false,
      "timezone": "Australia/Adelaide",
      "archived": false,
      "createdAt": "2023-07-30T09:00:00.000Z",
      "updatedAt": "2023-07-30T09:00:00.000Z"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

Authorizations

​
Authorization
string
header
required

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

Example:

200

​
id_lt
integer | null

The starting object id of the previous page

Example:

100

​
update_gt

Search for objects updated after this date time

Example:

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

​
update_lt

Search for objects updated before this date time

Example:

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

​
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

Example:

"Albus"

​
lastname
string | null

Practitioner last name

Example:

"Dumbledore"

​
email
string | null

Patient email

Example:

"albus@hogwarts.edu"

​
isActive
enum<string> | null

Whether the practitioner is active

Available options:
true,
false
Example:

"true"

​
roleName
string | null

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

Example:

"practitioner admin"

Response

200 - application/json

A paged array of practitioners

​
data
object[]
required
​
links
object
required