Retrieve the data of an appointment form

This API helps you to retrieve the data for tag forms associated to the specified appointment. You must provide an appropriate identifier in the API request for the appointment_id parameter. You also need to specify the required details for three other parameters in the API request. Refer to the Request Parameters table for more information.

Note: Retrieving/updating uploaded files, signatures and annotations are not supported.

Response Details

NameTypeDescription
datastringDetails of the service form.
guest_datastringGuest's details in JSON format.
is_form_submittedbooleanIndicates whether the appointment form has been submitted.
errorobjectObject that contains error code and error message details. For more information, refer to the error Object table.

error Object

codemessage
502Invalid appointment_id.
410Appointment Not Found.
438Cannot access.
4023something went wrong.
Language
Credentials
Header
Click Try It! to start a request and see the response here!