Responses List

GET

List survey responses requested by the user.

Query parameters

created_bystringOptional

Filters for survey responses created by any of these users.

cursorstringOptional

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

limitintegerOptional

The maximum number of survey responses to return. If not set, then the default is ‘50’.

mode"after" or "before"Optional

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore
objectsstringOptional

Filters for survey responses created for the objects.

recipientstringOptional

Filters for survey responses dispatched to any of these users.

sort_bystringOptional

Fields to sort the survey responses by and the direction to sort them.

stageslongOptionalDefaults to 0

Filters for survey response stages.

surveysstringOptional

Filters for survey responses for the provided survey IDs.

Response

This endpoint returns an object.
survey_responseslist of objects

The list of the survey responses.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.