List Surveys

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

1 { 2 "surveys": [ 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 "description": "foo", 24 "display_id": "foo", 25 "header": "foo", 26 "introductory_text": "foo", 27 "modified_by": { 28 "display_id": "foo", 29 "id": "foo", 30 "display_name": "foo", 31 "display_picture": { 32 "display_id": "foo", 33 "id": "foo", 34 "file": { 35 "type": "foo", 36 "name": "foo", 37 "size": 42 38 } 39 }, 40 "email": "foo", 41 "full_name": "foo", 42 "state": "active" 43 }, 44 "modified_date": "2023-01-01T12:00:00.000Z", 45 "name": "foo", 46 "response_text": "foo", 47 "schema": [ 48 { 49 "description": "foo", 50 "is_filterable": true, 51 "is_immutable": true, 52 "is_pii": true, 53 "is_required": true, 54 "mfz": {}, 55 "name": "foo", 56 "oasis": {}, 57 "origin": "foo", 58 "ui": { 59 "client_overrides": [ 60 { 61 "client_name": "foo", 62 "decimal_places": 42, 63 "display_name": "foo", 64 "is_groupable": true, 65 "is_hidden": true, 66 "order": 42, 67 "placeholder": "foo", 68 "tooltip": "foo", 69 "use_shorthand_notation": true, 70 "view_overrides": [ 71 {} 72 ] 73 } 74 ], 75 "decimal_places": 42, 76 "display_name": "foo", 77 "group_name": "foo", 78 "is_groupable": true, 79 "is_hidden": true, 80 "is_sortable": true, 81 "order": 42, 82 "placeholder": "foo", 83 "tooltip": "foo", 84 "unit": "foo", 85 "use_shorthand_notation": true 86 }, 87 "default_value": true 88 } 89 ], 90 "schema_with_metadata": [ 91 { 92 "field": { 93 "description": "foo", 94 "is_filterable": true, 95 "is_immutable": true, 96 "is_pii": true, 97 "is_required": true, 98 "mfz": {}, 99 "name": "foo", 100 "oasis": {}, 101 "origin": "foo", 102 "ui": { 103 "client_overrides": [ 104 { 105 "client_name": "foo", 106 "decimal_places": 42, 107 "display_name": "foo", 108 "is_groupable": true, 109 "is_hidden": true, 110 "order": 42, 111 "placeholder": "foo", 112 "tooltip": "foo", 113 "use_shorthand_notation": true, 114 "view_overrides": [ 115 null 116 ] 117 } 118 ], 119 "decimal_places": 42, 120 "display_name": "foo", 121 "group_name": "foo", 122 "is_groupable": true, 123 "is_hidden": true, 124 "is_sortable": true, 125 "order": 42, 126 "placeholder": "foo", 127 "tooltip": "foo", 128 "unit": "foo", 129 "use_shorthand_notation": true 130 }, 131 "default_value": true 132 }, 133 "metadata": {}, 134 "question": "foo" 135 } 136 ], 137 "title": "foo" 138 } 139 ], 140 "next_cursor": "foo", 141 "prev_cursor": "foo" 142 }

List surveys requested by the user.

Query parameters

created_bylist of stringsOptional

Filters for surveys created by any of these users.

cursorstringOptionalformat: "text"

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:

namelist of stringsOptional

Filters for surveys by name(s).

sort_bylist of stringsOptional

Fields to sort the surveys by and the direction to sort them.

Response

Success.

surveyslist of objects

The list of the surveys.

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