Skip to main content
POST
Get all respondents

Authorizations

api-key
string
header
required

Body

application/json

Request body for getting all respondents

surveyName
string
required

The name of the survey.

Response

When a request is successfully processed, the API responds with a 200 OK status code and the expected data.

success
enum<boolean>

A variable indicating whether the operation was successful.

Available options:
true,
false
message
string

A variable that human-readable message providing additional context or confirmation of the requested action.

results
object[]

This variable includes all quality parameters associated with a respondent.