Get a paged array of patients - splose API Documentation

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

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

Patient firstname

lastname

string | null

Patient lastname

email

string | null

Patient email

birthdate

string | null

Patient birth date in YYYY-MM-DD format

phoneNumber

string | null

Patient phone number without country code

patientTag

string | null

Patient tag

Response

200 - application/json

data

object[]

required

data.addressL1

string | null

required

Patient address line 1

data.addressL2

string | null

required

Patient address line 2

data.addressL3

string | null

required

Patient address line 3

data.alert

string | null

required

Patient alert messages

data.birthdate

string | null

required

Patient birthdate in YYYY-MM-DD format

data.city

string | null

required

Patient city

data.country

string | null

required

Patient country

data.createdAt

required

Object creation date time

data.email

string | null

required

Patient email

data.emergencyContactName

string | null

required

Patient emergency contact name

data.emergencyContactNumber

string | null

required

Patient emergency contact number

data.emergencyContactRelationship

string | null

required

Patient emergency contact relationship

data.extraBillingInfo

string | null

required

Patient extra billing info

data.extraInfo

string | null

required

Patient extra info

data.firstname

string

required

Patient first name

data.genderIdentity

string | null

required

Patient gender identity

data.id

integer

required

Patient Id

Required range: x > 0

data.invoiceRecipientId

integer | null

required

The invoice receipient (contact) id of this patient

Required range: x > 0

data.irn

string | null

required

Patient Medicare reference number

data.lastname

string

required

Patient last name

data.medicareNum

string | null

required

Patient Medicare number

data.middleName

string | null

required

Patient middle name

data.ndisNumber

string | null

required

Patient NDIS number

data.patientTags

string[]

required

Patient tags

data.phoneNumbers

object[]

required

data.postalCode

string | null

required

Patient post code

data.preferredName

string | null

required

Patient preferred name

data.privacyPolicy

enum<string> | null

required

Patient privacy policy status

Available options:

No response,

Accepted,

Rejected,

data.pronouns

string | null

required

Patient pronouns

data.sex

string | null

required

Patient sex

data.state

string | null

required

Patient state

data.timezone

string | null

required

Patient timezone

data.title

string | null

required

Patient title

data.updatedAt

required

Object update date time

data.veteransFileNumber

string | null

required

Patient veterans information

data.archived

boolean | null

default:

false

Whether the patient has been archived

data.customFields

object[] | null

data.healthFund

object

data.ndisInfo

object | null

links

object

required