Waivers & Forms API
The Waivers API provides access to your digital waivers and custom data collection forms.
Looking for Surveys?
Customer feedback surveys and NPS tracking have their own dedicated API. See Surveys for survey endpoints and analytics.
What are Waivers & Forms?
EquipDash supports two types of digital documents in this API:
| Type | Purpose | Example |
|---|---|---|
| Waivers | Legal liability releases | "Liability Waiver", "Rental Agreement" |
| Forms | Custom data collection | "Medical Information", "Emergency Contact" |
Waiver/Form Structure
Waiver/Form
├── Basic Info (name, type, status)
├── Fields[] (form field definitions)
│ ├── Text inputs
│ ├── Signatures
│ ├── Checkboxes
│ ├── Ratings (surveys)
│ └── File uploads
├── AssignedProducts[] (which products require this)
├── AssignedExperiences[] (which experiences require this)
└── Responses[] (submitted responses)
Field Types
| Field Type | Description | Used For |
|---|---|---|
text | Single line text | Names, short answers |
textarea | Multi-line text | Comments, descriptions |
email | Email validation | Email addresses |
phone | Phone number | Contact numbers |
number | Numeric input | Ages, quantities |
date | Date picker | Birth dates, dates |
checkbox | Single checkbox | Agreements, confirmations |
select | Dropdown | Multiple choice (single) |
radio | Radio buttons | Multiple choice options |
signature | Signature capture | Legal signatures |
rating | Star rating | Satisfaction scores (see Surveys for NPS) |
file | File upload | Documents, images |
Assignment Options
Waivers/forms can be assigned to:
| Assignment | Effect |
|---|---|
apply_to_all_products | Required for all product rentals |
apply_to_all_experiences | Required for all experience bookings |
| Specific products | Required only for those products |
| Specific experiences | Required only for those experiences |
API Endpoints
Management via Admin Interface
Waivers and forms are created and managed via the EquipDash admin interface. The API provides read access and response submission.
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
GET | /v1/waivers | List all waivers/forms/surveys | waivers:read |
GET | /v1/waivers/{id} | Get a single waiver with fields | waivers:read |
GET | /v1/waivers/{id}/responses | List responses for a waiver | waivers:read |
GET | /v1/waivers/{id}/responses/{responseId} | Get a single response | waivers:read |
POST | /v1/waivers/{id}/responses | Submit a response | waivers:write |
Common Use Cases
Checking Which Waivers Are Required
Before a booking, check what waivers need completion:
curl "https://app.equipdash.com/api/v1/waivers?status=active" \
-H "Authorization: Bearer YOUR_API_KEY"
Displaying Waiver Status in Your App
Show customers which waivers they've completed:
# Get waiver details including response count
curl "https://app.equipdash.com/api/v1/waivers/123" \
-H "Authorization: Bearer YOUR_API_KEY"
Filtering by Type
Get only waivers (exclude forms):
curl "https://app.equipdash.com/api/v1/waivers?type=waiver" \
-H "Authorization: Bearer YOUR_API_KEY"
Related Resources
- Products - Waivers can be assigned to products
- Experiences - Waivers can be assigned to experiences
- Customers - Customers submit waiver responses
- Surveys - Customer feedback and NPS tracking
- Webhooks -
form_response.submittedevent