Sign in
DiaryController

Get an appointment by ID

get/v3/diary/{shortName}/appointment

Path parameters

shortNamestring required

Company short name

Query parameters

appointmentIDstring required

Appointment ID

Response

OK

OIDstring

The unique Object ID (OID).

ETagstring

A unique identifier defining the object and change revision.

CreatedAtstring date-time

The date/time this appointment was created.

Startstring date-time

The start date/time of this appointment.

Endstring date-time

The end date/time of this appointment.

Subjectstring

The appointment subject text.

Commentstring

The appointment comments text.

Staffstring

The staff member holding this appointment.

CreatedBystring

The staff member that created this appointment.

Cancelledboolean

Whether the appointment has been cancelled.

AppointmentTypestring

The diary appointment type.

RemindAtstring date-time

The date/time to remind the staff member of this appointment.

RemindBefore'Min' | 'Min2' | 'Min5' | 'Min10' | 'Min15' | 'Min30' | 'Min45' | 'Hour' | 'Hour2' | 'Hour3' | 'Hour6' | 'Hour12' | 'Day' | 'Day2' | 'Day3' | 'Week' | 'NoReminder'

The number of minutes before the appointment start date/time to remind the staff member. -1 means don't remind.

Recurrenceinteger

The reccurrence interval for the appointment:-

RecurrenceTypestring

The type of recurrence:-

NextRecurringDatestring date-time

Date appointment next repeats:-

Changes

No recorded changes to this endpoint across all 1 revision of this API.