CAcarecycle
Appointments

Fetch a single appointment by id

Look up one appointment by its ID.

get/v2/appointments/{id}

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/appointments/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring uuid required

Appointment ID

Response

GET /v2/appointments/:id Positive response

idstring uuid required
startTimestring date-time required

Appointment start time. ISO 8601 timestamp

endTimestring date-time required

Appointment end time. ISO 8601 timestamp

timezonestring required
status'scheduled' | 'confirmed' | 'cancelled' | 'completed' | 'no_show' required
titlestring nullable required
appointmentMode'phone_call' | 'in_person' | 'video_call' | 'agent_phone_call' | 'null' nullable required
appointmentConfigIdstring uuid nullable required
bookingSource'ai_assistant' | 'manual' | 'scheduling_page' | 'null' nullable required
originCallIdstring uuid nullable required
confirmedAtstring date-time nullable required

Appointment confirmation time. ISO 8601 timestamp

additionalNotesstring nullable required
calendarEventIdstring nullable required
locationstring nullable required
meetingUrlstring nullable required
cancelledAtstring date-time nullable required

Appointment cancellation time. ISO 8601 timestamp

cancellationReasonstring nullable required
createdAtstring date-time nullable required

Appointment creation time. ISO 8601 timestamp

updatedAtstring date-time nullable required

Appointment last update time. ISO 8601 timestamp

Changes

No recorded changes to this operation across all 2 revisions of this API.