Skip to main content

Get Waiver/Form Response

Retrieve a single response by its ID, including all field values and associated data.

Endpointโ€‹

GET /v1/waivers/{id}/responses/{responseId}

Authenticationโ€‹

Requires an API key with the waivers:read scope.

Path Parametersโ€‹

ParameterTypeDescription
idintegerWaiver/form ID
responseIdintegerResponse ID

Example Requestโ€‹

curl -X GET "https://app.equipdash.com/api/v1/waivers/1/responses/42" \
-H "Authorization: Bearer YOUR_API_KEY"

Success Response (200 OK)โ€‹

Waiver Responseโ€‹

{
"data": {
"id": 42,
"waiver_form_id": 1,
"booking_id": 123,
"customer_id": 456,
"staff_id": null,
"submission_date": "2026-02-01T10:00:00+00:00",
"shown_field_ids": [1, 2, 3],
"documents": [
{
"id": 3,
"name": "Acknowledgement of Risk",
"download_url": "https://app.equipdash.com/api/v1/waivers/1/responses/42/documents/3/pdf",
"languages": [
{
"language": "en",
"download_url": "https://app.equipdash.com/api/v1/waivers/1/responses/42/documents/3/pdf?language=en"
},
{
"language": "fr",
"download_url": "https://app.equipdash.com/api/v1/waivers/1/responses/42/documents/3/pdf?language=fr"
}
]
}
],
"waiver": {
"id": 1,
"name": "Rental Waiver",
"type": "waiver"
},
"customer": {
"id": 456,
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"phone": "+1 555-123-4567"
},
"booking": {
"id": 123,
"status": "confirmed",
"start_date": "2026-02-05",
"end_date": "2026-02-07"
},
"responses": [
{
"field_id": 10,
"field_label": "Full Name",
"field_type": "fullName",
"value": "John Doe"
},
{
"field_id": 11,
"field_label": "Email Address",
"field_type": "email",
"value": "john@example.com"
},
{
"field_id": 12,
"field_label": "Phone Number",
"field_type": "phone",
"value": "+1 555-123-4567"
},
{
"field_id": 13,
"field_label": "Emergency Contact",
"field_type": "text",
"value": "Jane Doe - 555-987-6543"
},
{
"field_id": 14,
"field_label": "I acknowledge the risks and agree to the terms",
"field_type": "singleChoice",
"value": "Yes, I agree"
},
{
"field_id": 15,
"field_label": "Participant Signature",
"field_type": "signature",
"value": "https://app.equipdash.com/waivers-forms/responses/fields/123/signature?expires=1706785200&signature=abc123"
}
],
"created_at": "2026-02-01T10:00:00+00:00"
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-02-01T12:00:00+00:00"
}
}
Looking for Surveys?

For customer feedback surveys with NPS tracking, see the dedicated Surveys API.

Response Fieldsโ€‹

Response Objectโ€‹

FieldTypeDescription
idintegerUnique response identifier
waiver_form_idintegerID of the waiver/form
booking_idintegerAssociated booking ID (null if not linked)
customer_idintegerAssociated customer ID (null if not linked)
staff_idintegerStaff who collected the response (null if self-submitted)
submission_datestringISO 8601 datetime of submission
valid_untilstring|nullDate (YYYY-MM-DD) the signature stops satisfying new bookings โ€” the consent-on-file expiry; null = this booking only
signed_on_behalfbooleanWhether an authorized adult signed for the participant
signer_namestring|nullThe signer's name (on-behalf responses)
signer_emailstring|nullThe signer's email (on-behalf responses)
signer_relationshipstring|nullparent, guardian, carer, partner, or other (on-behalf responses)
shown_field_idsarray|nullField IDs actually shown to the respondent after conditional-logic evaluation. null on responses predating conditional logic. Use this as the denominator for per-question response rates so a gated question isn't counted as skipped by people who never saw it
documentsarrayThe PDF documents this response produces (empty if the form has no documents). Each has an id, name, a ready-to-use download_url (signed language), and a languages array โ€” one entry per language the document is generated in, each with its own download_url (the document download endpoint's ?language= form). See Download a Document PDF
waiverobjectWaiver/form details
customerobjectCustomer details (if linked)
bookingobjectBooking details (if linked)
responsesarrayArray of field responses
created_atstringISO 8601 creation datetime

Waiver Objectโ€‹

FieldTypeDescription
idintegerWaiver/form ID
namestringWaiver/form name
typestringwaiver or form

Customer Objectโ€‹

FieldTypeDescription
idintegerCustomer ID
first_namestringFirst name
last_namestringLast name
emailstringEmail address
phonestringPhone number (if available)

Booking Objectโ€‹

FieldTypeDescription
idintegerBooking ID
statusstringBooking status
start_datestringBooking start date (YYYY-MM-DD)
end_datestringBooking end date (YYYY-MM-DD)

Field Response Objectโ€‹

FieldTypeDescription
field_idintegerForm field ID
field_labelstringField label/question text
field_typestringField type
valuemixedResponse value (format depends on field type)

Field Value Formatsโ€‹

Field TypeValue FormatExample
text, shortTextstring"John"
longTextstring"Detailed feedback..."
fullNamestring"John Doe"
emailstring"john@example.com"
phonestring"+1 555-123-4567"
datestring (ISO 8601)"1990-05-15"
singleChoicestring"Option A"
multipleChoicearray["Option A", "Option C"]
signaturestring (URL)"https://equipdash.com/storage/..."
starRatingstring (1-5)"4"

Error Responsesโ€‹

Response Not Found (404)โ€‹

{
"error": {
"code": "resource_not_found",
"message": "Response not found."
},
"meta": {
"request_id": "req_abc123"
}
}

Waiver Not Found (404)โ€‹

{
"error": {
"code": "resource_not_found",
"message": "Waiver not found."
},
"meta": {
"request_id": "req_abc123"
}
}

Errorsโ€‹

StatusCodeDescription
401authentication_requiredNo API key provided
401invalid_api_keyInvalid API key
403insufficient_scopeAPI key lacks waivers:read scope
404resource_not_foundWaiver or response not found

Notesโ€‹

  • The response must belong to the specified waiver/form
  • Signature fields return short-lived signed URLs. Fetch the image promptly and request the response again if the URL expires.
  • Rating field values are returned as strings for consistency
  • Multiple choice responses are returned as arrays
  • For customer feedback surveys with NPS tracking, see Surveys