Skip to main content
Get a paged array of cases
curl --request GET \
  --url https://api.splose.com/v1/cases \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "contactId": 1,
      "issueDate": "2024-06-09T14:30:00.000Z",
      "expiryDate": "2024-06-25T14:29:59.000Z",
      "hours": 32,
      "practitionerId": 1,
      "items": [
        {
          "typeId": 1,
          "type": "Appointment"
        }
      ],
      "organisationId": 1,
      "patientId": 2,
      "caseNumber": "0002",
      "budget": 200,
      "appointmentCount": 12,
      "providerNumber": "1512",
      "referralPeriod": "Standard",
      "notes": "Notes",
      "trackType": "Budget",
      "includeDidNotArrive": true,
      "includeCancelled": true,
      "isOpen": true,
      "hasAlert": true,
      "remindTime": "Time",
      "utilisationAlert": 1,
      "isAlertUtilizationSent": 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
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
​
patientId
number | null

Patient id

Example:

1

​
practitionerId
number | null

Practitioner id

Example:

1

​
contactId
number | null

Contact id

Example:

1

​
trackType
enum<string> | null

Track type

Available options:
Appointments,
Hours,
Budget
Example:

"Budget"

​
status
enum<string> | null

Status

Available options:
Open,
Closed,
Expired
Example:

"Open"

Response

200 - application/json

A paged array of cases

​
data
object[]
required
​
links
object
required