GET Appointments/{id}

Get a single appointment

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Process Id	integer	Required

Body Parameters

None.

Response Information

Resource Description

Appointment details

Appointment

Name	Description	Type	Additional information
AppointmentId	Appointment Id (typically do not use this)	integer	None.
CaseId	Case Id - Use as the public facing booking reference (1:1 with Appointment Id)	integer	None.
ProcessId	Process Id - Use as Primary Key for appointments (typically 1:1 with Case Id)	integer	None.
ProcessGuid		globally unique identifier	None.
CreatedDate	Date/Time when appointment was created (server time zone)	date	None.
AppointmentDate	Appointment Date/Time (relative to the appointments time zone)	date	None.
ArrivalDate	Date/Time customer arrived (if appointment is in the past)	date	None.
TimeZoneOffset	Time Zone Offset in minutes from the server (-120 = 2 hours behind server)	integer	None.
AppointmentTypeId	Appointment Type Id	integer	None.
AppointmentTypeName	Appointment Type Name	string	Max length: 50
Duration	Appointment Type Duration in minutes	integer	None.
AppointmentTypeExtRef	Appointment Type External Reference	string	Max length: 200
CaseExtRef	Case Custom External Reference	string	Max length: 200
Subject	Case Subject field	string	Max length: 150
CurrentEntityStatus		integer	None.
CurrentEntityStatusDesc	Process Current Entity Status Description	string	Max length: 150
Resolution	Process Resolution Id. Null=Not resolved; 0=Complete; 1=Cancelled; 2=NoShow; 3=Abandoned; 4=Aborted; 5=Rescheduled	integer	Range: inclusive between 0 and 5
ResolutionDesc	Process Resolution Description	string	Max length: 150
ServiceId	Service Id	integer	None.
ServiceName	Service Name	string	Max length: 50
ServiceExtRef	Service Custom External Reference	string	Max length: 200
UnitId	Unit Id	integer	None.
UnitName	Unit Name	string	Max length: 50
UnitPath	Unit Name Path similar to a directory (ie \Org Name\State\Location)	string	Max length: 150
UnitExtRef	Unit Custom External Reference	string	Max length: 200
UnitAddress	Unit address	string	Max length: 250
Customer	Associated Customer record	Customer	None.
CustomProperties	Collection of all custom properties for this appointment process	Dictionary of string [key] and string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "AppointmentId": 1,
  "CaseId": 2,
  "ProcessId": 3,
  "ProcessGuid": "f7eefcf0-a6b7-466a-9010-2dbe37b0b326",
  "CreatedDate": "2025-09-13T08:26:07.4785354+10:00",
  "AppointmentDate": "2025-09-13T08:26:07.4785354+10:00",
  "ArrivalDate": "2025-09-13T08:26:07.4785354+10:00",
  "TimeZoneOffset": 8,
  "AppointmentTypeId": 9,
  "AppointmentTypeName": "sample string 10",
  "Duration": 11,
  "AppointmentTypeExtRef": "sample string 12",
  "CaseExtRef": "sample string 13",
  "Subject": "sample string 14",
  "CurrentEntityStatus": 15,
  "CurrentEntityStatusDesc": "sample string 16",
  "Resolution": 17,
  "ResolutionDesc": "sample string 18",
  "ServiceId": 19,
  "ServiceName": "sample string 20",
  "ServiceExtRef": "sample string 21",
  "UnitId": 22,
  "UnitName": "sample string 23",
  "UnitPath": "sample string 24",
  "UnitExtRef": "sample string 25",
  "UnitAddress": "sample string 26",
  "Customer": {
    "CustomerId": 1,
    "PersonalId": "sample string 2",
    "PersonalIdTypeId": 1,
    "PersonalIdTypeExtRef": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "Email": "sample string 6",
    "TelNumber1": "sample string 7",
    "TelNumber2": "sample string 8",
    "DOB": "2025-09-13T08:26:07.4941631+10:00",
    "Sex": 64,
    "Notes": "sample string 9",
    "ExtRef": "sample string 10",
    "NotificationConsent": true,
    "IsActive": true,
    "CustomProperties": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  },
  "CustomProperties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}