Get Appointment

Required scope: appointment:read

Returns the schedule window, agenda, appointment type, assigned member, status, and notes for one appointment. Access is limited to appointments whose customer the API key can read.

Generated Reference

POST /public-api/publicapi.v1.Appointment/GetAppointment

Reads one appointment by its stable ID. Returns not found when the appointment is outside the caller's appointment and customer visibility.

Request GetAppointmentRequest

Response GetAppointmentResponse

GetAppointmentRequest

Field	Type	Description
id	string	Appointment to fetch.

GetAppointmentResponse

Field	Type	Description
appointment	Appointment	The requested appointment.

Related Types

Appointment

Field	Type	Description
id	string	Appointment identifier.
customer_id	string	Customer the appointment is booked for.
agenda_id	string	Agenda the appointment belongs to.
appointment_type_id	string	Appointment type applied to the appointment.
assigned_member_id	string	Member currently assigned, or empty when unassigned.
scheduled_start_at	int64	Scheduled start as unix seconds.
scheduled_end_at	int64	Scheduled end as unix seconds.
duration_minutes	int32	Scheduled duration in minutes.
status	AppointmentStatus	Current lifecycle status.
notes	string	Free-text notes stored on the appointment.
created_at	int64	Unix seconds when the appointment was created.
updated_at	int64	Unix seconds when the appointment was last updated.

{
  "id": "<appointment-id>"
}