List Conversations (POST)

POST

https://api.devrev.ai/conversations.list

POST

/conversations.list

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

Try it

1 {
2   "conversations": [
3     {
4       "id": "foo",
5       "members": [
6         {
7           "display_id": "foo",
8           "id": "foo",
9           "display_name": "foo",
10           "display_picture": {
11             "display_id": "foo",
12             "id": "foo",
13             "file": {
14               "type": "foo",
15               "name": "foo",
16               "size": 42
17             }
18           },
19           "email": "foo",
20           "full_name": "foo",
21           "state": "active"
22         }
23       ],
24       "channels": [
25         {
26           "id": "foo",
27           "display_id": "foo"
28         }
29       ],
30       "created_by": {
31         "display_id": "foo",
32         "id": "foo",
33         "display_name": "foo",
34         "display_picture": {
35           "display_id": "foo",
36           "id": "foo",
37           "file": {
38             "type": "foo",
39             "name": "foo",
40             "size": 42
41           }
42         },
43         "email": "foo",
44         "full_name": "foo",
45         "state": "active"
46       },
47       "created_date": "2023-01-01T12:00:00.000Z",
48       "description": "foo",
49       "display_id": "foo",
50       "group": {
51         "id": "foo",
52         "display_id": "foo"
53       },
54       "messages": [
55         {
56           "created_by": {},
57           "created_date": "2023-01-01T12:00:00.000Z",
58           "display_id": "foo",
59           "id": "foo",
60           "modified_by": {},
61           "modified_date": "2023-01-01T12:00:00.000Z",
62           "object": "foo",
63           "object_display_id": "foo",
64           "object_type": "article",
65           "visibility": "external",
66           "artifacts": [
67             {
68               "display_id": "foo",
69               "id": "foo",
70               "file": {
71                 "type": "foo",
72                 "name": "foo",
73                 "size": 42
74               }
75             }
76           ],
77           "body": "foo",
78           "body_type": "data",
79           "references": [
80             {}
81           ],
82           "snap_kit_body": {
83             "body": {},
84             "snap_in_action_name": "foo",
85             "snap_in_id": "foo"
86           },
87           "snap_widget_body": [
88             {
89               "type": "foo"
90             }
91           ]
92         }
93       ],
94       "metadata": {
95         "url_context": "foo"
96       },
97       "modified_by": {
98         "display_id": "foo",
99         "id": "foo",
100         "display_name": "foo",
101         "display_picture": {
102           "display_id": "foo",
103           "id": "foo",
104           "file": {
105             "type": "foo",
106             "name": "foo",
107             "size": 42
108           }
109         },
110         "email": "foo",
111         "full_name": "foo",
112         "state": "active"
113       },
114       "modified_date": "2023-01-01T12:00:00.000Z",
115       "owned_by": [
116         {
117           "display_id": "foo",
118           "id": "foo",
119           "display_name": "foo",
120           "display_picture": {
121             "display_id": "foo",
122             "id": "foo",
123             "file": {
124               "type": "foo",
125               "name": "foo",
126               "size": 42
127             }
128           },
129           "email": "foo",
130           "full_name": "foo",
131           "state": "active"
132         }
133       ],
134       "sla_summary": {
135         "closest_to_breach_metric": "foo",
136         "org_schedule": {
137           "id": "foo",
138           "status": "archived",
139           "display_id": "foo",
140           "name": "foo",
141           "timezone": "foo",
142           "valid_until": "2023-01-01T12:00:00.000Z"
143         },
144         "remaining_time": 42,
145         "sla_tracker": {
146           "id": "foo",
147           "metric_target_summaries": [
148             {
149               "metric_definition": {
150                 "id": "foo",
151                 "display_id": "foo",
152                 "name": "foo"
153               },
154               "stage": "foo",
155               "breached_at": "2023-01-01T12:00:00.000Z",
156               "completed_at": "2023-01-01T12:00:00.000Z",
157               "completed_in": 42,
158               "in_policy": true,
159               "is_out_of_schedule": true,
160               "next_schedule_transition": "2023-01-01T12:00:00.000Z",
161               "org_schedule": {
162                 "id": "foo",
163                 "status": "archived",
164                 "display_id": "foo",
165                 "name": "foo",
166                 "timezone": "foo",
167                 "valid_until": "2023-01-01T12:00:00.000Z"
168               },
169               "remaining_time": 42,
170               "status": "foo",
171               "target_time": "2023-01-01T12:00:00.000Z",
172               "warning_target_time": "2023-01-01T12:00:00.000Z"
173             }
174           ],
175           "applies_to_id": "foo",
176           "applies_to_type": "conversation",
177           "created_by": {
178             "display_id": "foo",
179             "id": "foo",
180             "display_name": "foo",
181             "display_picture": {},
182             "email": "foo",
183             "full_name": "foo",
184             "state": "active"
185           },
186           "created_date": "2023-01-01T12:00:00.000Z",
187           "display_id": "foo",
188           "modified_by": {
189             "display_id": "foo",
190             "id": "foo",
191             "display_name": "foo",
192             "display_picture": {},
193             "email": "foo",
194             "full_name": "foo",
195             "state": "active"
196           },
197           "modified_date": "2023-01-01T12:00:00.000Z",
198           "removed_sla_metric_history": [
199             {}
200           ],
201           "sla": {
202             "id": "foo",
203             "name": "foo",
204             "status": "archived",
205             "display_id": "foo",
206             "sla_type": "external"
207           },
208           "sla_policy_id": "foo",
209           "stage": "foo",
210           "status": "foo"
211         },
212         "stage": "breached",
213         "target_time": "2023-01-01T12:00:00.000Z"
214       },
215       "sla_tracker": {
216         "id": "foo",
217         "applies_to_type": "conversation",
218         "display_id": "foo"
219       },
220       "source_channel": "foo",
221       "source_channel_v2": {
222         "id": "foo",
223         "display_id": "foo"
224       },
225       "stage": {
226         "name": "foo"
227       },
228       "tags": [
229         {
230           "tag": {
231             "id": "foo",
232             "name": "foo",
233             "display_id": "foo"
234           },
235           "value": "foo"
236         }
237       ],
238       "title": "foo"
239     }
240   ],
241   "next_cursor": "foo",
242   "prev_cursor": "foo"
243 }

Lists the available conversations.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.

actual_close_dateobjectOptional

Provides ways to specify date ranges on objects.

applies_to_partslist of stringsOptional

Filters for conversations belonging to any of the provided parts.

brandlist of stringsOptional

Filters for tickets that are associated with any of the brands.

channelslist of stringsOptional

Filters for conversations that are associated with any of the channels.

cursorstringOptionalformat: "text"

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

grouplist of stringsOptional

Filters for conversation that belong to the given groups.

is_creator_verifiedbooleanOptional

Filters for conversations that are created by verified users.

is_frozenbooleanOptional

Filters for conversations that are frozen.

is_spambooleanOptional

Filters for conversations that are spam.

limitintegerOptional

The maximum number of conversations to return. The default is '50'.

memberslist of stringsOptional

Filters for conversations where these users are participants.

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:

modified_dateobjectOptional

owned_bylist of stringsOptional

Filters for conversations owned by any of these users.

rev_orgslist of stringsOptional

Filters for conversations that are associated with any of the provided Rev organizations.

sla_summaryobjectOptional

The filter for SLA summary.

source_channellist of stringsOptional

Filters for conversations with any of the provided source channels.

source_channel_v2list of stringsOptional

Filters for conversations that are associated with the source channel.

stageobjectOptional

The filter for stages.

statelist of stringsOptional

Filters for conversations with any of the provided states.

tags_v2list of objectsOptional

Filters for conversations with any of the provided tags with value.

rev_orglist of stringsOptionalDeprecated

Filters for conversations that are associated with any of the provided Rev organizations.

source_channelslist of stringsOptionalDeprecated

Filters for conversations with any of the provided source channels.

tagslist of stringsOptionalDeprecated

Filters for conversations with any of the provided tags.

Response

The response to listing the conversations.

conversationslist of objects

The list of conversations.

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