get
https://api.zenoti.com//v1/guests//guest_forms
This API retrieves guest form details for a given guest.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Response Details
FormDetailsV1
| Json Property | Data Type | Description |
|---|---|---|
| form_id | Guid | Unique identifier of the form. |
| name | string | Name of the form. |
| is_expired | bool | Indicates whether the form has expired. |
| form_filled_status | FormFilledStatus | Current completion status of the form. |
| last_filled_date | DateTime | Date and time when the form was last filled. Returned in the context center's timezone, or the guest's center timezone for API key requests. |
| last_filled_by | string | Name of the user who last filled the form. |
| form_type | FormType | Type of the form. |
| viewonly | bool? | Indicates whether the form is view-only. |
| is_html_changed | bool | Indicates whether the form HTML has been modified since the last version. |
| form_url | string | URL used to access the form. |
| form_history | List | History of form versions. Returned only when expand=history is specified. |
FormVersionsV1
| Json Property | Data Type | Description |
|---|---|---|
| version_date | DateTime | Date and time when the form version was created. Returned in the context center's timezone, or the guest's center timezone for API key requests. |
| version_id | string | Unique identifier of the form version. |
| created_by | string | Name of the user who created the form version. |
| form_name | string | Name of the form. |
| form_id | Guid | Unique identifier of the form. |
| form_url | string | URL used to access the specific form version. |
| form_type | FormType | Type of the form. |
FormFilledStatus (Enum)
| Value | Name | Description |
|---|---|---|
| -1 | NoForm | No form is available. |
| 0 | NotFilled | Form has not been filled. |
| 1 | Saved | Form has been saved but not submitted. |
| 2 | Submitted | Form has been completed and submitted. |
FormType (Enum)
| Value | Description |
|---|---|
| Enum | Represents the type of form. Exact enum values are not provided in the source code. |
Error Response
ApiErrorViewModel
| Json Property | Data Type | Description |
|---|---|---|
| code | string | Application-specific error code. |
| message | string | Human-readable description of the error. |