surveys

Responses List Post

POST
List survey responses requested by the user.

Request

This endpoint expects an object.
created_by
list of stringsOptional
Filters for survey responses created by any of these users.
created_date
unionOptional
Provides ways to specify date ranges on objects.
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
limit
integerOptional
The maximum number of survey responses to return. If not set, then the default is '50'.
mode
enumOptional
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.
Allowed values: afterbefore
modified_date
unionOptional
Provides ways to specify date ranges on objects.
objects
list of stringsOptional
Filters for survey responses created for the objects.
sort_by
list of stringsOptional
Fields to sort the survey responses by and the direction to sort them.
surveys
list of stringsOptional
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.
POST
1curl -X POST https://api.devrev.ai/surveys.responses.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200
Successful
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}
Built with