List Surveys (POST)

POST

List surveys requested by the user.

Request

This endpoint expects an object.

created_bylist of stringsOptional

Filters for surveys 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.

limitintegerOptional

The maximum number of surveys 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.

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_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.

Errors

POST

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

200surveysListPostExample

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           "default_value": true
60         }
61       ],
62       "schema_with_metadata": [
63         {
64           "field": {
65             "description": "foo",
66             "is_filterable": true,
67             "is_immutable": true,
68             "is_pii": true,
69             "is_required": true,
70             "mfz": {},
71             "name": "foo",
72             "oasis": {},
73             "origin": "foo",
74             "ui": {},
75             "default_value": true
76           },
77           "metadata": {},
78           "question": "foo"
79         }
80       ],
81       "title": "foo"
82     }
83   ],
84   "next_cursor": "foo",
85   "prev_cursor": "foo"
86 }

List Surveys Responses

Up Next

Built with

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

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	"default_value": true
60	}
61	],
62	"schema_with_metadata": [
63	{
64	"field": {
65	"description": "foo",
66	"is_filterable": true,
67	"is_immutable": true,
68	"is_pii": true,
69	"is_required": true,
70	"mfz": {},
71	"name": "foo",
72	"oasis": {},
73	"origin": "foo",
74	"ui": {},
75	"default_value": true
76	},
77	"metadata": {},
78	"question": "foo"
79	}
80	],
81	"title": "foo"
82	}
83	],
84	"next_cursor": "foo",
85	"prev_cursor": "foo"
86	}