curl --request GET \
  --url https://api.splose.com/v1/patients/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

Response

200 - application/json
id
integer
required

Patient Id

firstname
string
required

Patient first name

lastname
string
required

Patient last name

middleName
string | null
required

Patient middle name

preferredName
string | null
required

Patient preferred name

title
string | null
required

Patient title

email
string | null
required

Patient email

sex
string | null
required

Patient sex

genderIdentity
string | null
required

Patient gender identity

pronouns
string | null
required

Patient pronouns

alert
string | null
required

Patient alert messages

birthdate
string | null
required

Patient birthdate in YYYY-MM-DD format

timezone
string | null
required

Patient timezone

extraInfo
string | null
required

Patient extra info

extraBillingInfo
string | null
required

Patient extra billing info

addressL1
string | null
required

Patient address line 1

addressL2
string | null
required

Patient address line 2

addressL3
string | null
required

Patient address line 3

city
string | null
required

Patient city

state
string | null
required

Patient state

postalCode
string | null
required

Patient post code

country
string | null
required

Patient country

phoneNumbers
object[]
required
privacyPolicy
enum<string> | null
required

Patient privacy policy status

Available options:
No response,
Accepted,
Rejected
healthFund
object
ndisNumber
string | null
required

Patient NDIS number

medicareNum
string | null
required

Patient Medicare number

irn
string | null
required

Patient Medicare reference number

veteransFileNumber
string | null
required

Patient veterans information

emergencyContactNumber
string | null
required

Patient emergency contact number

emergencyContactName
string | null
required

Patient emergency contact name

emergencyContactRelationship
string | null
required

Patient emergency contact relationship

patientTags
string[]
required

Patient tags

archived
boolean | null
default: false

Whether the patient has been archived

createdAt
required

Object creation date time

updatedAt
required

Object update date time

Get a paged array of patientsGet a paged array of services