Skip to main content

Get Survey Response

Retrieve a single survey response by ID.

Endpointโ€‹

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

Path Parametersโ€‹

ParameterTypeDescription
idintegerSurvey ID
responseIdintegerResponse ID

Authenticationโ€‹

Requires an API key with the surveys:read scope.

Responseโ€‹

Success (200 OK)โ€‹

{
"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",
"waiver": {
"id": 1,
"name": "Customer Satisfaction Survey",
"type": "survey"
},
"customer": {
"id": 456,
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com"
},
"booking": {
"id": 123,
"status": "confirmed"
},
"responses": [
{
"field_id": 10,
"field_label": "How likely are you to recommend us?",
"field_type": "npsRating",
"value": "9"
},
{
"field_id": 11,
"field_label": "Rate our equipment quality",
"field_type": "starRating",
"value": "5"
},
{
"field_id": 12,
"field_label": "How did you hear about us?",
"field_type": "singleChoice",
"value": "Friend referral"
},
{
"field_id": 13,
"field_label": "Additional comments",
"field_type": "longText",
"value": "Excellent service! The staff was very helpful and the equipment was in perfect condition."
}
],
"nps_score": 9,
"nps_category": "promoter",
"created_at": "2026-02-01T10:00:00+00:00"
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-01-15T12:00:00+00:00"
}
}

Response Fieldsโ€‹

FieldTypeDescription
idintegerResponse ID
waiver_form_idintegerSurvey ID
booking_idintegerLinked booking ID (if any)
customer_idintegerLinked customer ID (if any)
staff_idintegerStaff who collected response (if any)
submission_datestringISO 8601 datetime of submission
waiverobjectSurvey summary
customerobjectFull customer details (if linked)
bookingobjectBooking summary (if linked)
responsesarrayAll field responses
nps_scoreintegerNPS rating value (if survey has NPS field)
nps_categorystringpromoter, passive, or detractor
created_atstringISO 8601 datetime

Response Field Objectโ€‹

FieldTypeDescription
field_idintegerThe survey field ID
field_labelstringThe question/label text
field_typestringType of field
valuestringThe submitted value

Errorsโ€‹

StatusCodeDescription
401authentication_requiredNo API key provided
401invalid_api_keyInvalid API key
403insufficient_scopeAPI key lacks surveys:read scope
403forbiddenSurvey belongs to another supplier
404not_foundSurvey or response not found

Example Requestโ€‹

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