Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
calendar

Get Appointment Details

Use this endpoint to get the appointment details for a specific calendar event.

get/calendars/{calendarId}/appointments/{appointmentId}

Path parameters

calendarIdstring uuid required

The calendar's unique identifier

appointmentIdstring uuid required

The appointment's unique identifier

Response

OK

idstring uuid

The unique GUID of the calendar event.

titlestring

The name of the calendar event.

startstring date-time

The start date/time of the event.

endstring date-time

The end date/time of the event.

allDayboolean

Whether the event is an all day event.

jobIdstring

The unique GUID of the job associated with the event, if any.

jobNamestring

The name of the job associated with the event, if any.\

locationstring

The address where the appointment is to take place.

notesstring

other information related to the appointment.

eventType'Personal' | 'Initial Appointment' | 'Material Order' | 'Labor Order'
_linkstring

The URI of the this calendar event.

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "Initial Appointment",
  "start": "2023-12-07T16:03:47Z",
  "end": "2024-01-07T16:03:47Z",
  "jobId": "b4c09ad6-1d53-4a34-8a45-d989660e12d8",
  "jobName": "RC-2120: John Smith",
  "location": "123 Pleasant Grove Road, \\nACity, IL, 12345",
  "notes": "Customer contact information:\\nCompany Name- Contact Name\\nJob: N/A\\n1234 Pleasant Grove Road, \\nACity, IL, 12345\\n(555) 123-45671 - mobile - Primary\\nmyemail@myprovider.net - Primary\\n",
  "_link": "https://api.acculynx.com/api/v2/calendars/58ca0eab-7882-46a6-8456-854beae8fb4a/appointments/3fa85f64-5717-4562-b3fc-2c963f66afa6"
}