Responses List Post

POST

List survey responses requested by the user.

Request

This endpoint expects an object.
created_bylist of stringsOptional

Filters for survey responses created by any of these users.

created_dateobjectOptional

Provides ways to specify date ranges on objects.

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
Allowed values: afterbefore

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

modified_dateobjectOptional

Provides ways to specify date ranges on objects.

objectslist of stringsOptional

Filters for survey responses created for the objects.

recipientlist of stringsOptional

Filters for survey responses dispatched to any of these users.

sort_bylist of stringsOptional

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

stageslist of longsOptional

Filters for survey response stages.

surveyslist of stringsOptional

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.