List Surveys Responses

1 curl https://api.devrev.ai/surveys.responses.list \ 2 -H "Authorization: Bearer <token>"

1 { 2 "survey_responses": [ 3 { 4 "id": "foo", 5 "created_by": { 6 "display_id": "foo", 7 "id": "foo", 8 "display_name": "foo", 9 "display_picture": { 10 "display_id": "foo", 11 "id": "foo", 12 "file": { 13 "type": "foo", 14 "name": "foo", 15 "size": 42 16 } 17 }, 18 "email": "foo", 19 "full_name": "foo", 20 "state": "active" 21 }, 22 "created_date": "2023-01-01T12:00:00.000Z", 23 "dispatch_id": "foo", 24 "dispatched_channels": [ 25 { 26 "id": 42, 27 "label": "foo", 28 "ordinal": 42, 29 "value": null 30 } 31 ], 32 "display_id": "foo", 33 "modified_by": { 34 "display_id": "foo", 35 "id": "foo", 36 "display_name": "foo", 37 "display_picture": { 38 "display_id": "foo", 39 "id": "foo", 40 "file": { 41 "type": "foo", 42 "name": "foo", 43 "size": 42 44 } 45 }, 46 "email": "foo", 47 "full_name": "foo", 48 "state": "active" 49 }, 50 "modified_date": "2023-01-01T12:00:00.000Z", 51 "object": "foo", 52 "recipient": { 53 "display_id": "foo", 54 "id": "foo", 55 "display_name": "foo", 56 "display_picture": { 57 "display_id": "foo", 58 "id": "foo", 59 "file": { 60 "type": "foo", 61 "name": "foo", 62 "size": 42 63 } 64 }, 65 "email": "foo", 66 "full_name": "foo", 67 "state": "active" 68 }, 69 "response": {}, 70 "response_channel": { 71 "id": 42, 72 "label": "foo", 73 "ordinal": 42, 74 "value": null 75 }, 76 "stage": { 77 "id": 42, 78 "label": "foo", 79 "ordinal": 42, 80 "value": null 81 }, 82 "survey": "foo" 83 } 84 ], 85 "next_cursor": "foo", 86 "prev_cursor": "foo" 87 }

List survey responses requested by the user.

Query parameters

created_bylist of stringsOptional

Filters for survey responses created by any of these users.

cursorstringOptionalformat: "text"

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

dispatch_idslist of stringsOptional

Filters for survey responses associated with these unique IDs.

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:

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

Success.

survey_responseslist of objects

The list of the survey responses.

next_cursorstring or nullformat: "text"

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

prev_cursorstring or nullformat: "text"

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

Headers

Query parameters

Response

Errors