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.
Permission:Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.
Endpoint
GET /v1/appointments/{appointment_id}/forms_data
Base URL:https://api.zenoti.com
Request
Headers
Header
Required
Description
Authorization
Yes
bearer {{access_token}}
Path parameters
Parameter
Type
Required
Description
appointment_id
string
Yes
Mandatory Unique 32-character identifier of the appointment for which you want to retrieve form data.
Query parameters
Parameter
Type
Required
Default
Description
tag_id
string
Yes
—
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
integer (int32)
Yes
—
MandatoryCurrently, 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
integer (int32)
Yes
—
MandatoryCurrently, 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.
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.GetAsync(
"https://api.zenoti.com/v1/appointments/{appointment_id}/forms_data");
var data = await response.Content.ReadAsStringAsync();