Skip to content

Read the one survey response a call produced

GET
/v1/calls/{call_id}/survey-response
curl --request GET \
--url https://api.vocapable.com/v1/calls/example/survey-response \
--header 'Authorization: Bearer <token>'

The single-fetch convenience over the collection filter.

A call produces at most one response (uq_survey_responses_call_id), so the integrator’s common path - “the webhook named this call; give me its answers” - is one GET rather than a filtered list walk. 404 when the call collected none.

call_id
required
Call Id
string

Successful Response

Media typeapplication/json
SurveyResponse
object
id
required
Id
string
call_id
required
Call Id
string
agent_version_id
required
Agent Version Id
string
answers
Answers
object
key
additional properties
any
completion_status
required
Completion Status
string
Allowed values: complete partial refused
score
Any of:
number
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
"completion_status": "complete"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}