Waivers & Forms Tools
View waiver and form templates, check completion status for bookings, view submitted responses, and send forms to customers.
Required scope: waivers:read for read tools, waivers:write for write tools
Tools Overview
| Tool | Description | Read-only? |
|---|---|---|
list_forms | List all waiver and form templates | Yes |
get_form | Get form details including fields and assignments | Yes |
get_form_responses | List submitted responses for a form | Yes |
get_booking_form_status | Has everyone on a booking signed? Waivers to sign, and post-trip surveys listed apart | Yes |
send_form_to_customer | Generate and send a form access link to a customer | No |
list_forms
List all waiver and form templates for the business.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
search | string | No | Search by form name |
get_form
Get details of a waiver/form template including fields and assigned products/experiences.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
form_id | integer | Yes | The form ID |
get_form_responses
List responses submitted for a waiver/form. Returns submitter name, submission date, and all submitted field values.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
form_id | integer | Yes | The form ID |
date | string | No | Filter by submission date (e.g., today, 2026-02-13) |
limit | integer | No | Number of results (default 10) |
get_booking_form_status
Has everyone on a booking signed? Returns the waivers each person signs before the activity (forms, all_signed) and, separately, the post-trip surveys (surveys). A survey is feedback after the trip, never a signature. Same shape as GET /v1/bookings/{id}/form-status.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
booking_id | integer | Yes | The booking ID |
send_form_to_customer
Generate an access link for a waiver/form for a booking customer. Returns the URL that can be shared with the customer.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
booking_id | integer | Yes | The booking ID |
form_id | integer | Yes | The form ID to send |
user_confirmed | boolean | Yes | Must be true to send |
create_waiver
Create a new waiver/form with optional initial fields. The user can add more fields later in the editor.
Required scope: waivers:write
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Waiver/form name |
description | string | No | Short summary |
content | string | No | Intro text shown to the customer (becomes a TextBlock at the top) |
fields | array | No | Optional initial fields, each with label, type, required |
Field type may be: text, textarea, date, phone, email, yes_no, signature.
Returns
{
"success": true,
"message": "Waiver 'Watersports Liability Waiver' created.",
"waiver": { "id": 7, "name": "Watersports Liability Waiver", "unique_code": "abc123def456" }
}
Related
- Waivers & Forms REST API - REST API endpoints for waivers and forms
- Bookings Tools - Booking management