Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
support-activity

Get a paged array of support-activities

Get a paged array of support-activities

get/support-activities

Query parameters

id_gtinteger nullable

The starting object id of the next page

Example:200
id_ltinteger nullable

The starting object id of the previous page

Example:100
string
OR
string
string
OR
string
include_archived'true' | 'false' nullable

Whether archived objects should be retrieved, default is false

start_gtstring nullable

Search for support activities start after this date time

Example:2023-07-30T09:00:00.000Z
start_ltstring nullable

Search for support activities start before this date time

Example:2023-07-30T09:00:00.000Z
patientIdnumber nullable

Search for support activities with this patient id

Example:1

Response

A paged array of support-activities

Example response

{
  "data": [
    {
      "id": 1,
      "patientId": 1,
      "practitionerId": 1,
      "serviceId": 1,
      "locationId": 1,
      "caseId": 1,
      "note": "Some notes",
      "repeatId": "12345678-abcd-4321-dcba-12a34b56c78d",
      "recurringRule": "DTSTART:2023080T010000ZRRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=6",
      "pricing": 193.99,
      "quantity": 193.99,
      "invoiceId": 1
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}