List Commands

GET

Lists commands for a Dev organization.

Query parameters

cursorstringOptionalformat: "text"

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

executor_typelist of enumsOptional

Filtering based on executor_type.

Allowed values: regoworkflow

limitintegerOptional

The maximum number of commands to return per page. The default is ‘50’.

modeenumOptional

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore

namespacelist of stringsOptional

Filter commands based on namespace.

sort_bylist of stringsOptional

List of fields to sort the commands items by and how to sort them.

source_object_idstringOptionalformat: "id"

ID of the object where command is invoked (work/part/conversation).

statuslist of enumsOptional

Filter commands based on status.

Allowed values: disableddraftenabled

Response

Success.

commandslist of objects

List of commands.

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

GET

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

200listExample

1 {
2   "commands": [
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       "display_name": "foo",
26       "modified_by": {
27         "display_id": "foo",
28         "id": "foo",
29         "display_name": "foo",
30         "display_picture": {
31           "display_id": "foo",
32           "id": "foo",
33           "file": {
34             "type": "foo",
35             "name": "foo",
36             "size": 42
37           }
38         },
39         "email": "foo",
40         "full_name": "foo",
41         "state": "active"
42       },
43       "modified_date": "2023-01-01T12:00:00.000Z",
44       "name": "foo",
45       "namespace": "foo",
46       "shared_with": [
47         {
48           "member": {
49             "display_id": "foo",
50             "id": "foo",
51             "display_name": "foo",
52             "display_picture": {
53               "display_id": "foo",
54               "id": "foo",
55               "file": {}
56             },
57             "email": "foo",
58             "full_name": "foo",
59             "state": "active"
60           },
61           "role": {
62             "id": "foo",
63             "display_id": "foo",
64             "sync_metadata": {
65               "external_reference": "foo",
66               "origin_system": "foo"
67             }
68           }
69         }
70       ],
71       "status": "disabled",
72       "surfaces": [
73         {
74           "object_types": [
75             "account"
76           ],
77           "surface": "customer_chat"
78         }
79       ],
80       "usage_hint": "foo"
81     }
82   ],
83   "next_cursor": "foo",
84   "prev_cursor": "foo"
85 }

List Commands (POST)

Up Next

Built with

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

1	{
2	"commands": [
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	"display_name": "foo",
26	"modified_by": {
27	"display_id": "foo",
28	"id": "foo",
29	"display_name": "foo",
30	"display_picture": {
31	"display_id": "foo",
32	"id": "foo",
33	"file": {
34	"type": "foo",
35	"name": "foo",
36	"size": 42
37	}
38	},
39	"email": "foo",
40	"full_name": "foo",
41	"state": "active"
42	},
43	"modified_date": "2023-01-01T12:00:00.000Z",
44	"name": "foo",
45	"namespace": "foo",
46	"shared_with": [
47	{
48	"member": {
49	"display_id": "foo",
50	"id": "foo",
51	"display_name": "foo",
52	"display_picture": {
53	"display_id": "foo",
54	"id": "foo",
55	"file": {}
56	},
57	"email": "foo",
58	"full_name": "foo",
59	"state": "active"
60	},
61	"role": {
62	"id": "foo",
63	"display_id": "foo",
64	"sync_metadata": {
65	"external_reference": "foo",
66	"origin_system": "foo"
67	}
68	}
69	}
70	],
71	"status": "disabled",
72	"surfaces": [
73	{
74	"object_types": [
75	"account"
76	],
77	"surface": "customer_chat"
78	}
79	],
80	"usage_hint": "foo"
81	}
82	],
83	"next_cursor": "foo",
84	"prev_cursor": "foo"
85	}