get https://api.zenoti.com/v1/appointments//forms
This API helps you to fetch the list of forms that are available for the specified appointment.
You must specify appropriate details for the appointment_id parameter in the API request.
Response Details
| Name | Type | Description |
|---|---|---|
| appointment_id | guid | Unique 32-character identifier of the appointment for which you want to retrieve the list of forms. |
| form_id | guid | Unique 32-character identifier of the form that is associated with the appointment. |
| service_name | string | Name of the service in that appointment. |
| service_displayname | string | Display name of the service in that appointment. |
| name | string | Name of the guest. |
| is_filled | boolean | Indicates whether the form has been filled. |
| is_submitted | boolean | Indicates whether the form has been submitted. |
| lastfilled_date | datetime | Date and time on which the form was last filled. |
| form_type | enum | Indicates the type of the form: NoForm - 0, ServiceKeyValuePair - 1, ServiceHtmlForm - 2, GuestHtmlForm - 3, GuestKeyValuePair - 4, and TagForm - 5. |
| lastfilled_by | string | Name of the person who last filled details in the form. |
| latest_version | string | Latest version details of the form. |
| form_history | object | Object that contains these form history-related elements: version_date, version_id, created_by, form_name, and form_id. |
| is_viewonly | boolean | Indicates whether the form is a view-only form. |
| expiry_date | datetime | Date and time at which the the form will or has already expired. |
| is_editable | boolean | Indicates whether the contents of the form can be modified. |
| is_expired | boolean | Indicates whether the form has already crossed its date of expiry. |
| owner_id | guid? | Unique 32-character identifier of the form's owner. |
| is_service_form | boolean | Indicates whether the form is a service-type form. |
| source_appointment_date | string | Date and time of the appointment to which the form is associated. |
| permissions | object | Object that contains these form permissions-related elements: can_view and can_edit. |