Get a paged array of patients

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

import requests

url = "https://api.splose.com/v1/patients"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.splose.com/v1/patients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.splose.com/v1/patients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.splose.com/v1/patients"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.splose.com/v1/patients")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.splose.com/v1/patients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "firstname": "Harry",
      "lastname": "Potter",
      "id": 1,
      "deletedAt": "2023-07-30T09:00:00.000Z",
      "middleName": "James",
      "preferredName": "Harry",
      "title": "Mr.",
      "email": "harry@hogwarts.edu",
      "sex": "Male",
      "genderIdentity": "Man",
      "pronouns": "They/them",
      "alert": "He knows magic",
      "invoiceRecipientId": 1,
      "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": "",
      "addressL3": "",
      "city": "Adelaide",
      "state": "SA",
      "postalCode": "5000",
      "country": "Australia",
      "phoneNumbers": [
        {
          "phoneNumber": "401234567",
          "type": "Mobile",
          "code": "+61"
        }
      ],
      "privacyPolicy": "Accepted",
      "ndisNumber": "430123456",
      "ndisInfo": {
        "diagnosis": "Foot Injury",
        "nomineeEmail": "nominee@email.com",
        "fundManagement": "Plan-managed",
        "nomineeLastName": "Clark",
        "nomineeFirstName": "Chris",
        "nomineeMobileCode": "+61",
        "nomineeMobileNumber": "433555111",
        "startDate": "2024-02-09T00:00:00.000Z",
        "endDate": "2024-02-18T00:00:00.000Z"
      },
      "medicareNum": "4444444444",
      "irn": "1",
      "veteransFileNumber": "",
      "emergencyContactNumber": "0412345678",
      "emergencyContactName": "Quentin Neely",
      "emergencyContactRelationship": "Brother",
      "communicationPreference": "SMS",
      "archived": false,
      "patientTags": [
        "Self-managed"
      ],
      "customFields": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "healthFund": {
        "name": "AHM",
        "membershipNumber": "12345678",
        "patientNumber": "1",
        "cardIssueNumber": "01"
      },
      "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 a paged array of patients

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

import requests

url = "https://api.splose.com/v1/patients"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.splose.com/v1/patients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.splose.com/v1/patients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.splose.com/v1/patients"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.splose.com/v1/patients")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.splose.com/v1/patients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "firstname": "Harry",
      "lastname": "Potter",
      "id": 1,
      "deletedAt": "2023-07-30T09:00:00.000Z",
      "middleName": "James",
      "preferredName": "Harry",
      "title": "Mr.",
      "email": "harry@hogwarts.edu",
      "sex": "Male",
      "genderIdentity": "Man",
      "pronouns": "They/them",
      "alert": "He knows magic",
      "invoiceRecipientId": 1,
      "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": "",
      "addressL3": "",
      "city": "Adelaide",
      "state": "SA",
      "postalCode": "5000",
      "country": "Australia",
      "phoneNumbers": [
        {
          "phoneNumber": "401234567",
          "type": "Mobile",
          "code": "+61"
        }
      ],
      "privacyPolicy": "Accepted",
      "ndisNumber": "430123456",
      "ndisInfo": {
        "diagnosis": "Foot Injury",
        "nomineeEmail": "nominee@email.com",
        "fundManagement": "Plan-managed",
        "nomineeLastName": "Clark",
        "nomineeFirstName": "Chris",
        "nomineeMobileCode": "+61",
        "nomineeMobileNumber": "433555111",
        "startDate": "2024-02-09T00:00:00.000Z",
        "endDate": "2024-02-18T00:00:00.000Z"
      },
      "medicareNum": "4444444444",
      "irn": "1",
      "veteransFileNumber": "",
      "emergencyContactNumber": "0412345678",
      "emergencyContactName": "Quentin Neely",
      "emergencyContactRelationship": "Brother",
      "communicationPreference": "SMS",
      "archived": false,
      "patientTags": [
        "Self-managed"
      ],
      "customFields": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "healthFund": {
        "name": "AHM",
        "membershipNumber": "12345678",
        "patientNumber": "1",
        "cardIssueNumber": "01"
      },
      "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

ids

integer[] | null

Required array length: 1 - 100 elements

Required range: x > 0

firstname

string | null

Patient firstname

Example:

"Harry"

lastname

string | null

Patient lastname

Example:

"Potter"

string<email> | null

Patient email

Example:

"harry@hogwarts.edu"

birthdate

string | null

Patient birth date in YYYY-MM-DD format

Example:

"1990-01-01T00:00:00.000Z"

phoneNumber

string | null

Patient phone number without country code

Example:

"0412345678"

patientTag

string | null

Patient tag

Example:

"Self-managed"

Response

200 - application/json

A paged array of patients

data

object[]

required

Show child attributes

links

object

required

Show child attributes

Introduction Create a single patient

Get started

API Reference

Get a paged array of patients

Authorizations

Query Parameters

Response