Retrieve the data of an appointment form

get

https://api.zenoti.com/v1/appointments/{appointment_id}/forms_data?tag_Id={tag_id}&view_context={view_context}&version_no={version_no}

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

Response Details

Name	Type	Description
data	string	Details of the service form.
guest_data	string	Guest's details in JSON format.
is_form_submitted	boolean	Indicates whether the appointment form has been submitted.
error	object	Object that contains error code and error message details. For more information, refer to the error Object table.

error Object

code	message
502	Invalid appointment_id.
410	Appointment Not Found.
438	Cannot access.
4023	something went wrong.

Path Params

appointment_id

string

required

Mandatory Unique 32-character identifier of the appointment for which you want to retrieve form data.

Query Params

tag_id

string

required

Mandatory Unique 32-character identifier of the tag. If you want to retrieve a tag form, you must specify the specific guid of the tag in the API request.

view_context

int32

required

Mandatory Currently, this parameter is not functional. You must either pass 0 or an empty string ("") in the request for this API to work. Indicates the type of context from which you want to view the appointment form data. The view_context type can either be organization-level or center-level: 0 - organization and 1 - center.

version_no

int32

required

Mandatory Currently, this parameter is not functional. You must either pass 0 or an empty string ("") in the request for this API to work. Indicates the version number of the appointment form. If you pass an integer value for this parameter in the API request, the form data of the specified appointment version will be returned in the API response.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Response Details

error Object

200200

400400