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": "[email protected]",
      "title": "Dr",
      "profession": "Physiotherapist",
      "description": "Practitioner admin of Hogwarts",
      "roleName": "practitioner admin",
      "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"
  }
}

GET

practitioners

curl --request GET \
  --url https://api.splose.com/v1/practitioners \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 1,
      "firstname": "Albus",
      "lastname": "Dumbledore",
      "email": "[email protected]",
      "title": "Dr",
      "profession": "Physiotherapist",
      "description": "Practitioner admin of Hogwarts",
      "roleName": "practitioner admin",
      "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"

string | null

Patient email

Example:

"[email protected]"

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

Show child attributes

data.id

integer

required

Practitioner id

Required range: x > 0

Example:

1

data.firstname

string

required

Practitioner first name

Example:

"Albus"

data.lastname

string

required

Practitioner last name

Example:

"Dumbledore"

data.email

string<email> | null

required

Practitioner email

data.title

string | null

required

Practitioner title

Example:

"Dr"

data.profession

string | null

required

Practitioner profession

Example:

"Physiotherapist"

data.description

string | null

required

Practitioner description

Example:

"Practitioner admin of Hogwarts"

data.roleName

string

required

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

Example:

"practitioner admin"

data.providerNumbers

object[]

required

Show child attributes

data.providerNumbers.type

string

required

Provider number type

Example:

"Medicare"

data.providerNumbers.number

string

required

Provider number

Example:

"12345678"

data.providerNumbers.locationId

integer | null

required

The location of this provider number

Required range: x > 0

Example:

1

data.deletedAt

required

Object archived date time

Example:

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

data.isActive

boolean | null

default:true

Whether the practitioner is active

data.onlineBooking

boolean | null

default:false

Whether online booking is enabled

data.timezone

string | null

Practitioner timezone

Example:

"Australia/Adelaide"

data.archived

boolean | null

default:false

Whether the practitioner has been archived

data.createdAt

Object creation date time

Example:

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

data.updatedAt

Object update date time

Example:

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

links

object

required

Show child attributes

links.previousPage

string

The link to retrieve next page

Example:

"/v1/${object_type}?id_gt=200"

links.nextPage

string

The link to retrieve previous page

Example:

"/v1/${object_type}?id_lt=100"

Get a single location Get a single practitioner

⌘I

Get started

API Reference

Get a paged array of practitioners

Authorizations

Query Parameters

Response