surveys

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'.
modeenumOptional
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.
sort_bystringOptional
Fields to sort the survey responses by and the direction to sort them.
surveysstringOptional
Filters for survey responses for the provided survey IDs.

Response

This endpoint returns an object
survey_responses
list of objects
The list of the survey responses.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
GET
1curl https://api.devrev.ai/surveys.responses.list \
2 -H "Authorization: <apiKey>"
200
Retrieved
1{
2 "survey_responses": [
3 {
4 "id": "id",
5 "created_date": "2023-01-01T12:00:00Z",
6 "dispatch_id": "dispatch_id",
7 "display_id": "display_id",
8 "modified_date": "2023-01-01T12:00:00Z",
9 "object": "object",
10 "survey": "survey"
11 }
12 ],
13 "next_cursor": "next_cursor",
14 "prev_cursor": "prev_cursor"
15}