Get a paged array of patients

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

{
  "data": [
    {
      "id": 1,
      "firstname": "Harry",
      "lastname": "Potter",
      "middleName": "James",
      "preferredName": "Harry",
      "title": "Mr.",
      "email": "harry@hogwarts.edu",
      "sex": "Male",
      "genderIdentity": "Man",
      "pronouns": "They/them",
      "alert": "He knows magic",
      "birthdate": "1996-07-30T00:00:00.000Z",
      "timezone": "Australia/Adelaide",
      "extraInfo": "Some extra info",
      "extraBillingInfo": "Some extra billing info",
      "addressL1": "123 King William Street",
      "addressL2": "<string>",
      "addressL3": "<string>",
      "city": "Adelaide",
      "state": "SA",
      "postalCode": "5000",
      "country": "Australia",
      "phoneNumbers": [
        {
          "type": "Mobile",
          "code": "+61",
          "phoneNumber": "401234567"
        }
      ],
      "privacyPolicy": "Accepted",
      "healthFund": {
        "name": "AHM",
        "membershipNumber": "12345678",
        "patientNumber": "1",
        "cardIssueNumber": "01"
      },
      "ndisNumber": "430123456",
      "medicareNum": "4444444444",
      "irn": "1",
      "veteransFileNumber": "<string>",
      "emergencyContactNumber": "0412345678",
      "emergencyContactName": "Quentin Neely",
      "emergencyContactRelationship": "Brother",
      "patientTags": [
        "Self-managed"
      ],
      "archived": true,
      "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

headerrequired

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

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.id

integer

required

Patient Id

data.firstname

string

required

Patient first name

data.lastname

string

required

Patient last name

data.middleName

string | null

required

Patient middle name

data.preferredName

string | null

required

Patient preferred name

data.title

string | null

required

Patient title

data.email

string | null

required

Patient email

data.sex

string | null

required

Patient sex

data.genderIdentity

string | null

required

Patient gender identity

data.pronouns

string | null

required

Patient pronouns

data.alert

string | null

required

Patient alert messages

data.birthdate

string | null

required

Patient birthdate in YYYY-MM-DD format

data.timezone

string | null

required

Patient timezone

data.extraInfo

string | null

required

Patient extra info

data.extraBillingInfo

string | null

required

Patient extra billing info

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.city

string | null

required

Patient city

data.state

string | null

required

Patient state

data.postalCode

string | null

required

Patient post code

data.country

string | null

required

Patient country

data.phoneNumbers

object[]

required

data.privacyPolicy

enum<string> | null

required

Patient privacy policy status

Available options:

No response,

Accepted,

Rejected

data.healthFund

object

data.ndisNumber

string | null

required

Patient NDIS number

data.medicareNum

string | null

required

Patient Medicare number

data.irn

string | null

required

Patient Medicare reference number

data.veteransFileNumber

string | null

required

Patient veterans information

data.emergencyContactNumber

string | null

required

Patient emergency contact number

data.emergencyContactName

string | null

required

Patient emergency contact name

data.emergencyContactRelationship

string | null

required

Patient emergency contact relationship

data.patientTags

string[]

required

Patient tags

data.archived

boolean | null

default: false

Whether the patient has been archived

data.createdAt

required

Object creation date time

data.updatedAt

required

Object update date time

links

object

required

Introduction Get a single patient

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

{
  "data": [
    {
      "id": 1,
      "firstname": "Harry",
      "lastname": "Potter",
      "middleName": "James",
      "preferredName": "Harry",
      "title": "Mr.",
      "email": "harry@hogwarts.edu",
      "sex": "Male",
      "genderIdentity": "Man",
      "pronouns": "They/them",
      "alert": "He knows magic",
      "birthdate": "1996-07-30T00:00:00.000Z",
      "timezone": "Australia/Adelaide",
      "extraInfo": "Some extra info",
      "extraBillingInfo": "Some extra billing info",
      "addressL1": "123 King William Street",
      "addressL2": "<string>",
      "addressL3": "<string>",
      "city": "Adelaide",
      "state": "SA",
      "postalCode": "5000",
      "country": "Australia",
      "phoneNumbers": [
        {
          "type": "Mobile",
          "code": "+61",
          "phoneNumber": "401234567"
        }
      ],
      "privacyPolicy": "Accepted",
      "healthFund": {
        "name": "AHM",
        "membershipNumber": "12345678",
        "patientNumber": "1",
        "cardIssueNumber": "01"
      },
      "ndisNumber": "430123456",
      "medicareNum": "4444444444",
      "irn": "1",
      "veteransFileNumber": "<string>",
      "emergencyContactNumber": "0412345678",
      "emergencyContactName": "Quentin Neely",
      "emergencyContactRelationship": "Brother",
      "patientTags": [
        "Self-managed"
      ],
      "archived": true,
      "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 started

API Reference

Authorizations

Query Parameters

Response