Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
appointment

Get a paged array of appointments

Get a paged array of appointments

get/appointments

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

string
OR
string
OR
{"stackTrail":"paths:/appointments:get:parameters:5:schema:anyOf:2","oasType":"schema","type":"unknown","nullable":true}
string
OR
string
OR
{"stackTrail":"paths:/appointments:get:parameters:6:schema:anyOf:2","oasType":"schema","type":"unknown","nullable":true}
patientIdnumber nullable

Search for appointments with this patient id

Example:1
practitionerIdnumber nullable

Search for appointments with this practitioner id

Example:1
status'Arrived' | 'Did not arrive' | 'Cancelled' | 'Completed' nullable

Patient status of this appointment

string
OR
string
OR
{"stackTrail":"paths:/appointments:get:parameters:10:schema:anyOf:2","oasType":"schema","type":"unknown","nullable":true}
string
OR
string
OR
{"stackTrail":"paths:/appointments:get:parameters:11:schema:anyOf:2","oasType":"schema","type":"unknown","nullable":true}

Response

A paged array of appointments

Example response

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