List Surveys Responses (POST) (Beta) — DevRev

List survey responses requested by the user.

Request

This endpoint expects an object.

created_bylist of stringsOptional

Filters for survey responses created by any of these users.

created_dateobjectOptional

Provides ways to specify date ranges on objects.

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

Allowed values: afterbefore

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.

modified_dateobjectOptional

Provides ways to specify date ranges on objects.

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_cursorstringOptionalformat: "text"

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

prev_cursorstringOptionalformat: "text"

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

1 curl -X POST https://api.devrev.ai/surveys.responses.list \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

1 { 2 "survey_responses": [ 3 { 4 "id": "id", 5 "created_by": { 6 "type": "dev_user", 7 "id": "id", 8 "display_id": "display_id", 9 "display_name": "display_name", 10 "display_picture": { 11 "id": "id", 12 "file": {} 13 }, 14 "email": "email", 15 "full_name": "full_name", 16 "state": "active" 17 }, 18 "created_date": "created_date", 19 "dispatch_id": "dispatch_id", 20 "dispatched_channels": [ 21 { 22 "id": 1000000, 23 "label": "label", 24 "ordinal": 1000000 25 }, 26 { 27 "id": 1000000, 28 "label": "label", 29 "ordinal": 1000000 30 } 31 ], 32 "display_id": "display_id", 33 "modified_by": { 34 "type": "dev_user", 35 "id": "id", 36 "display_id": "display_id", 37 "display_name": "display_name", 38 "display_picture": { 39 "id": "id", 40 "file": {} 41 }, 42 "email": "email", 43 "full_name": "full_name", 44 "state": "active" 45 }, 46 "modified_date": "modified_date", 47 "object": "object", 48 "recipient": { 49 "type": "dev_user", 50 "id": "id", 51 "display_id": "display_id", 52 "display_name": "display_name", 53 "display_picture": { 54 "id": "id", 55 "display_id": "display_id", 56 "file": {} 57 }, 58 "email": "email", 59 "full_name": "full_name", 60 "state": "active" 61 }, 62 "response": {}, 63 "response_channel": { 64 "id": 1000000, 65 "label": "label", 66 "ordinal": 1000000 67 }, 68 "stage": { 69 "id": 1000000, 70 "label": "label", 71 "ordinal": 1000000 72 }, 73 "survey": "survey" 74 }, 75 { 76 "id": "id", 77 "created_by": { 78 "type": "dev_user", 79 "id": "id", 80 "display_id": "display_id", 81 "display_name": "display_name", 82 "display_picture": { 83 "id": "id", 84 "file": {} 85 }, 86 "email": "email", 87 "full_name": "full_name", 88 "state": "active" 89 }, 90 "created_date": "created_date", 91 "dispatch_id": "dispatch_id", 92 "dispatched_channels": [ 93 { 94 "id": 1000000, 95 "label": "label", 96 "ordinal": 1000000 97 }, 98 { 99 "id": 1000000, 100 "label": "label", 101 "ordinal": 1000000 102 } 103 ], 104 "display_id": "display_id", 105 "modified_by": { 106 "type": "dev_user", 107 "id": "id", 108 "display_id": "display_id", 109 "display_name": "display_name", 110 "display_picture": { 111 "id": "id", 112 "file": {} 113 }, 114 "email": "email", 115 "full_name": "full_name", 116 "state": "active" 117 }, 118 "modified_date": "modified_date", 119 "object": "object", 120 "recipient": { 121 "type": "dev_user", 122 "id": "id", 123 "display_id": "display_id", 124 "display_name": "display_name", 125 "display_picture": { 126 "id": "id", 127 "display_id": "display_id", 128 "file": {} 129 }, 130 "email": "email", 131 "full_name": "full_name", 132 "state": "active" 133 }, 134 "response": {}, 135 "response_channel": { 136 "id": 1000000, 137 "label": "label", 138 "ordinal": 1000000 139 }, 140 "stage": { 141 "id": 1000000, 142 "label": "label", 143 "ordinal": 1000000 144 }, 145 "survey": "survey" 146 } 147 ], 148 "next_cursor": "next_cursor", 149 "prev_cursor": "prev_cursor" 150 }

1	curl -X POST https://api.devrev.ai/surveys.responses.list \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"survey_responses": [
3	{
4	"id": "id",
5	"created_by": {
6	"type": "dev_user",
7	"id": "id",
8	"display_id": "display_id",
9	"display_name": "display_name",
10	"display_picture": {
11	"id": "id",
12	"file": {}
13	},
14	"email": "email",
15	"full_name": "full_name",
16	"state": "active"
17	},
18	"created_date": "created_date",
19	"dispatch_id": "dispatch_id",
20	"dispatched_channels": [
21	{
22	"id": 1000000,
23	"label": "label",
24	"ordinal": 1000000
25	},
26	{
27	"id": 1000000,
28	"label": "label",
29	"ordinal": 1000000
30	}
31	],
32	"display_id": "display_id",
33	"modified_by": {
34	"type": "dev_user",
35	"id": "id",
36	"display_id": "display_id",
37	"display_name": "display_name",
38	"display_picture": {
39	"id": "id",
40	"file": {}
41	},
42	"email": "email",
43	"full_name": "full_name",
44	"state": "active"
45	},
46	"modified_date": "modified_date",
47	"object": "object",
48	"recipient": {
49	"type": "dev_user",
50	"id": "id",
51	"display_id": "display_id",
52	"display_name": "display_name",
53	"display_picture": {
54	"id": "id",
55	"display_id": "display_id",
56	"file": {}
57	},
58	"email": "email",
59	"full_name": "full_name",
60	"state": "active"
61	},
62	"response": {},
63	"response_channel": {
64	"id": 1000000,
65	"label": "label",
66	"ordinal": 1000000
67	},
68	"stage": {
69	"id": 1000000,
70	"label": "label",
71	"ordinal": 1000000
72	},
73	"survey": "survey"
74	},
75	{
76	"id": "id",
77	"created_by": {
78	"type": "dev_user",
79	"id": "id",
80	"display_id": "display_id",
81	"display_name": "display_name",
82	"display_picture": {
83	"id": "id",
84	"file": {}
85	},
86	"email": "email",
87	"full_name": "full_name",
88	"state": "active"
89	},
90	"created_date": "created_date",
91	"dispatch_id": "dispatch_id",
92	"dispatched_channels": [
93	{
94	"id": 1000000,
95	"label": "label",
96	"ordinal": 1000000
97	},
98	{
99	"id": 1000000,
100	"label": "label",
101	"ordinal": 1000000
102	}
103	],
104	"display_id": "display_id",
105	"modified_by": {
106	"type": "dev_user",
107	"id": "id",
108	"display_id": "display_id",
109	"display_name": "display_name",
110	"display_picture": {
111	"id": "id",
112	"file": {}
113	},
114	"email": "email",
115	"full_name": "full_name",
116	"state": "active"
117	},
118	"modified_date": "modified_date",
119	"object": "object",
120	"recipient": {
121	"type": "dev_user",
122	"id": "id",
123	"display_id": "display_id",
124	"display_name": "display_name",
125	"display_picture": {
126	"id": "id",
127	"display_id": "display_id",
128	"file": {}
129	},
130	"email": "email",
131	"full_name": "full_name",
132	"state": "active"
133	},
134	"response": {},
135	"response_channel": {
136	"id": 1000000,
137	"label": "label",
138	"ordinal": 1000000
139	},
140	"stage": {
141	"id": 1000000,
142	"label": "label",
143	"ordinal": 1000000
144	},
145	"survey": "survey"
146	}
147	],
148	"next_cursor": "next_cursor",
149	"prev_cursor": "prev_cursor"
150	}