List Appointment Result Codes

Required scope: appointment:read

Lists the visit result codes configured on the agenda of one appointment, including whether each resolves the linked work order or needs follow-up. Use the returned resultCodeId when recording a result with Record Appointment Result.

Generated Reference

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

Lists the active visit result codes selectable for one appointment.

Request ListAppointmentResultCodesRequest

Response ListAppointmentResultCodesResponse

ListAppointmentResultCodesRequest

Field	Type	Description
appointment_id	string	Appointment whose agenda result codes are listed.

ListAppointmentResultCodesResponse

Field	Type	Description
result_codes	repeated AppointmentResultCode	Result codes selectable for the appointment.

Related Types

AppointmentResultCode

Field	Type	Description
id	string	Result code identifier.
label	string	Human-readable result label.
solves_work_order	bool	Whether selecting this result resolves the linked work order.
needs_follow_up	bool	Whether selecting this result flags the appointment for follow-up.

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