surveys

List

GET
List surveys requested by the user.

Query parameters

created_bystringOptional
Filters for surveys 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 surveys 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
namestringOptional
Filters for surveys by name(s).
sort_bystringOptional
Fields to sort the surveys by and the direction to sort them.

Response

This endpoint returns an object
surveys
list of objects
The list of the surveys.
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.list \
2     -H "Authorization: <apiKey>"
200
Retrieved
1{
2  "surveys": [
3    {
4      "id": "id",
5      "schema": [],
6      "created_date": "2023-01-01T12:00:00Z",
7      "description": "description",
8      "display_id": "display_id",
9      "modified_date": "2023-01-01T12:00:00Z",
10      "name": "name"
11    }
12  ],
13  "next_cursor": "next_cursor",
14  "prev_cursor": "prev_cursor"
15}
Built with