Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
appointment

Get a single appointment

Get appointment data by id

get/appointments/{id}

Path parameters

idinteger required
Example:1

Response

Object with appointment data.

idinteger required

Appointment id

isUnavailableBlockboolean nullable

@deprecated - please refer to the new busy-time endpoint. Whether this time slot is unavailable, eg. busy time or meeting

busyTimePractitionerIdsinteger[]

@deprecated - please refer to the new busy-time endpoint. The practitioner ids of this multiple practitioners busy time

serviceIdinteger nullable required

The service id of this appointment

locationIdinteger required

The location id of this appointment

practitionerIdinteger nullable required

The practitioner id of this appointment

maxPatientsinteger required

The max patient number of this appointment. A number greater than 1 indicates a group appointment.

repeatIdstring nullable required

An recurring appointment will have this repeat id

recurringRulestring nullable required

The rule for recurring appointment

unit'Hour' | 'Each' nullable required

The appointment unit

pricingnumber nullable required

The appointment unit price, in dollar

totalnumber nullable required

The appointment total price without tax, in dollar

supportItemIdsinteger[] required

Array of support item ids of this appointment

notestring nullable required

The appointment note

archivedboolean nullable

Whether the appointment has been archived

Example response

{
  "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"
}