Get a paged array of cases

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

{
  "data": [
    {
      "id": 1,
      "caseNumber": "0002",
      "budget": 200,
      "appointmentCount": 12,
      "contactId": 1,
      "providerNumber": "1512",
      "referralPeriod": "Standard",
      "issueDate": "2024-06-09T14:30:00.000Z",
      "expiryDate": "2024-06-25T14:29:59.000Z",
      "notes": "Notes",
      "trackType": "Budget",
      "hours": 32,
      "includeDidNotArrive": true,
      "includeCancelled": true,
      "practitionerId": 1,
      "items": [
        {
          "typeId": 1,
          "type": "Appointment"
        }
      ],
      "organisationId": 1,
      "patientId": 2,
      "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

data.id

integer

required

Case id

Required range: x > 0

Example:

1

data.contactId

integer | null

required

Contact Id

Required range: x > 0

Example:

1

data.issueDate

required

Issued date in YYYY-MM-DD HH:MM:SS format

Example:

"2024-06-09T14:30:00.000Z"

data.expiryDate

required

Expiry date in YYYY-MM-DD HH:MM:SS format

Example:

"2024-06-25T14:29:59.000Z"

data.hours

number | null

required

hours

Example:

32

data.practitionerId

integer | null

required

Practitioner id

Required range: x > 0

Example:

1

data.items

object[]

required

An array of appointment connections associated with this case

data.organisationId

integer

required

Organisation id

Required range: x > 0

Example:

1

data.patientId

integer

required

Patient id

Required range: x > 0

Example:

2

data.caseNumber

string

Case number

Example:

"0002"

data.budget

number | null

Budget

Example:

200

data.appointmentCount

number | null

Appointment count

Example:

12

data.providerNumber

string | null

Provider number

Example:

"1512"

data.referralPeriod

string | null

Referral Period

Example:

"Standard"

data.notes

string | null

Notes

Example:

"Notes"

data.trackType

enum<string>

Track type

Available options:

Appointments,

Hours,

Budget

Example:

"Budget"

data.includeDidNotArrive

boolean | null

Did not arrive

Example:

true

data.includeCancelled

boolean | null

Include cancelled

Example:

true

data.isOpen

boolean | null

Is open

Example:

true

data.hasAlert

boolean | null

Has alert

Example:

true

data.remindTime

string | null

Remind time

Example:

"Time"

data.utilisationAlert

number | null

Utilisation alert

Example:

1

data.isAlertUtilizationSent

boolean | null

Is alert utilization sent

Example:

true

data.createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

data.updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"

links

object

required

Get a single patient-form Get a single case

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

{
  "data": [
    {
      "id": 1,
      "caseNumber": "0002",
      "budget": 200,
      "appointmentCount": 12,
      "contactId": 1,
      "providerNumber": "1512",
      "referralPeriod": "Standard",
      "issueDate": "2024-06-09T14:30:00.000Z",
      "expiryDate": "2024-06-25T14:29:59.000Z",
      "notes": "Notes",
      "trackType": "Budget",
      "hours": 32,
      "includeDidNotArrive": true,
      "includeCancelled": true,
      "practitionerId": 1,
      "items": [
        {
          "typeId": 1,
          "type": "Appointment"
        }
      ],
      "organisationId": 1,
      "patientId": 2,
      "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"
  }
}

Get started

API Reference

Authorizations

Query Parameters

Response