List Commands (POST) | DevRev

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

1 { 2 "commands": [ 3 { 4 "id": "foo", 5 "action": { 6 "code": "foo", 7 "executor_type": "rego", 8 "message": "foo" 9 }, 10 "created_by": { 11 "display_id": "foo", 12 "id": "foo", 13 "display_name": "foo", 14 "display_picture": { 15 "display_id": "foo", 16 "id": "foo", 17 "file": { 18 "type": "foo", 19 "name": "foo", 20 "size": 42 21 } 22 }, 23 "email": "foo", 24 "full_name": "foo", 25 "state": "active" 26 }, 27 "created_date": "2023-01-01T12:00:00.000Z", 28 "description": "foo", 29 "display_id": "foo", 30 "display_name": "foo", 31 "modified_by": { 32 "display_id": "foo", 33 "id": "foo", 34 "display_name": "foo", 35 "display_picture": { 36 "display_id": "foo", 37 "id": "foo", 38 "file": { 39 "type": "foo", 40 "name": "foo", 41 "size": 42 42 } 43 }, 44 "email": "foo", 45 "full_name": "foo", 46 "state": "active" 47 }, 48 "modified_date": "2023-01-01T12:00:00.000Z", 49 "name": "foo", 50 "namespace": "foo", 51 "shared_with": [ 52 { 53 "member": { 54 "display_id": "foo", 55 "id": "foo", 56 "display_name": "foo", 57 "display_picture": { 58 "display_id": "foo", 59 "id": "foo", 60 "file": {} 61 }, 62 "email": "foo", 63 "full_name": "foo", 64 "state": "active" 65 }, 66 "role": { 67 "id": "foo", 68 "display_id": "foo", 69 "sync_metadata": { 70 "external_reference": "foo", 71 "origin_system": "foo" 72 } 73 } 74 } 75 ], 76 "source": { 77 "id": "foo", 78 "display_id": "foo" 79 }, 80 "status": "disabled", 81 "surfaces": [ 82 { 83 "object_types": [ 84 "account" 85 ], 86 "surface": "customer_chat" 87 } 88 ], 89 "usage_hint": "foo" 90 } 91 ], 92 "next_cursor": "foo", 93 "prev_cursor": "foo" 94 }

Lists commands for a Dev organization.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

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:

limitintegerOptional

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

modeenumOptional

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.

Allowed values:

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:

Response

Success.

commandslist of objects

List of commands.

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

Request

Response

Errors