• About
    • For Developers
  • API Reference
    • Changelog
  • Guides
    • Account creation
    • Agents async API
    • Links
API Referenceconversations

Get Conversation

GET
https://api.devrev.ai/conversations.get
GET
/conversations.get
1curl -G https://api.devrev.ai/conversations.get \
2 -H "Authorization: Bearer <token>" \
3 -d id=id
Try it
200Retrieved
1{
2 "conversation": {
3 "id": "string",
4 "members": [
5 {
6 "display_id": "string",
7 "id": "string",
8 "display_name": "string",
9 "display_picture": {
10 "display_id": "string",
11 "id": "string",
12 "file": {
13 "type": "string",
14 "name": "string",
15 "size": 1
16 }
17 },
18 "email": "string",
19 "full_name": "string",
20 "state": "active"
21 }
22 ],
23 "actual_close_date": "2023-01-01T12:00:00.000Z",
24 "channels": [
25 {
26 "id": "string",
27 "display_id": "string"
28 }
29 ],
30 "created_by": {
31 "display_id": "string",
32 "id": "string",
33 "display_name": "string",
34 "display_picture": {
35 "display_id": "string",
36 "id": "string",
37 "file": {
38 "type": "string",
39 "name": "string",
40 "size": 1
41 }
42 },
43 "email": "string",
44 "full_name": "string",
45 "state": "active"
46 },
47 "created_date": "2023-01-01T12:00:00.000Z",
48 "custom_fields": {},
49 "custom_schema_fragments": [
50 "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
51 ],
52 "description": "string",
53 "display_id": "string",
54 "group": {
55 "id": "string",
56 "display_id": "string",
57 "member_type": "dev_user",
58 "name": "string",
59 "sync_metadata": {
60 "external_reference": "string",
61 "origin_system": "string"
62 }
63 },
64 "messages": [
65 {
66 "created_by": {
67 "display_id": "string",
68 "id": "string",
69 "display_name": "string",
70 "display_picture": {
71 "display_id": {},
72 "id": {},
73 "file": {}
74 },
75 "email": "string",
76 "full_name": "string",
77 "state": "active"
78 },
79 "created_date": "2023-01-01T12:00:00.000Z",
80 "display_id": "string",
81 "id": "string",
82 "modified_by": {
83 "display_id": "string",
84 "id": "string",
85 "display_name": "string",
86 "display_picture": {
87 "display_id": {},
88 "id": {},
89 "file": {}
90 },
91 "email": "string",
92 "full_name": "string",
93 "state": "active"
94 },
95 "modified_date": "2023-01-01T12:00:00.000Z",
96 "external_ref": "string",
97 "labels": [
98 "string"
99 ],
100 "object": "string",
101 "object_display_id": "string",
102 "object_type": "account",
103 "panels": [
104 "alerts"
105 ],
106 "reactions": [
107 {
108 "emoji": "string",
109 "reacted": true,
110 "total_users": 1
111 }
112 ],
113 "sync_metadata": {
114 "external_reference": "string",
115 "last_sync_in": {
116 "status": "failed",
117 "sync_date": "2023-01-01T12:00:00.000Z",
118 "sync_unit": {
119 "display_id": "string",
120 "id": "string",
121 "external_system_type": "adaas",
122 "is_archived": true,
123 "name": "string",
124 "sync_run": {
125 "mode": "initial",
126 "progress": {
127 "state": {}
128 }
129 },
130 "sync_type": "manual"
131 }
132 },
133 "last_sync_out": {
134 "status": "failed",
135 "sync_date": "2023-01-01T12:00:00.000Z",
136 "sync_unit": {
137 "display_id": "string",
138 "id": "string",
139 "external_system_type": "adaas",
140 "is_archived": true,
141 "name": "string",
142 "sync_run": {
143 "mode": "initial",
144 "progress": {
145 "state": {}
146 }
147 },
148 "sync_type": "manual"
149 }
150 },
151 "origin_system": "string"
152 },
153 "thread": {
154 "total_replies": 1
155 },
156 "visibility": "external",
157 "event": {
158 "type": "annotated",
159 "created": {
160 "object": {
161 "display_id": "string",
162 "id": "string",
163 "display_name": "string"
164 }
165 },
166 "deleted": {
167 "object_id": "string"
168 },
169 "linked": {
170 "link": {
171 "display_id": "string",
172 "id": "string",
173 "link_type": "custom_link",
174 "source": {},
175 "target": {}
176 }
177 },
178 "updated": {
179 "field_deltas": [
180 {
181 "field_descriptor": {
182 "description": {},
183 "is_filterable": {},
184 "is_immutable": {},
185 "is_pii": {},
186 "is_required": {},
187 "mfz": {},
188 "name": {},
189 "oasis": {},
190 "origin": {},
191 "ui": {},
192 "default_value": {}
193 },
194 "name": "string",
195 "new_value": {
196 "fields": {}
197 },
198 "old_value": {
199 "fields": {}
200 }
201 }
202 ],
203 "object_type": "string"
204 }
205 }
206 }
207 ],
208 "metadata": {
209 "url_context": "string"
210 },
211 "modified_by": {
212 "display_id": "string",
213 "id": "string",
214 "display_name": "string",
215 "display_picture": {
216 "display_id": "string",
217 "id": "string",
218 "file": {
219 "type": "string",
220 "name": "string",
221 "size": 1
222 }
223 },
224 "email": "string",
225 "full_name": "string",
226 "state": "active"
227 },
228 "modified_date": "2023-01-01T12:00:00.000Z",
229 "owned_by": [
230 {
231 "display_id": "string",
232 "id": "string",
233 "display_name": "string",
234 "display_picture": {
235 "display_id": "string",
236 "id": "string",
237 "file": {
238 "type": "string",
239 "name": "string",
240 "size": 1
241 }
242 },
243 "email": "string",
244 "full_name": "string",
245 "state": "active"
246 }
247 ],
248 "sla_summary": {
249 "closest_to_breach_metric": "string",
250 "org_schedule": {
251 "id": "string",
252 "status": "archived",
253 "display_id": "string",
254 "name": "string",
255 "timezone": "string",
256 "valid_until": "2023-01-01T12:00:00.000Z"
257 },
258 "remaining_time": 1,
259 "sla_tracker": {
260 "id": "string",
261 "metric_target_summaries": [
262 {
263 "metric_definition": {
264 "id": "string",
265 "display_id": "string",
266 "name": "string"
267 },
268 "stage": "string",
269 "breached_at": "2023-01-01T12:00:00.000Z",
270 "completed_at": "2023-01-01T12:00:00.000Z",
271 "completed_in": 1,
272 "in_policy": true,
273 "is_out_of_schedule": true,
274 "next_schedule_transition": "2023-01-01T12:00:00.000Z",
275 "org_schedule": {
276 "id": "string",
277 "status": "archived",
278 "display_id": "string",
279 "name": "string",
280 "timezone": "string",
281 "valid_until": "2023-01-01T12:00:00.000Z"
282 },
283 "remaining_time": 1,
284 "status": "string",
285 "target_time": "2023-01-01T12:00:00.000Z",
286 "warning_target_time": "2023-01-01T12:00:00.000Z"
287 }
288 ],
289 "applies_to_id": "string",
290 "applies_to_type": "conversation",
291 "created_by": {
292 "display_id": "string",
293 "id": "string",
294 "display_name": "string",
295 "display_picture": {
296 "display_id": "string",
297 "id": "string",
298 "file": {
299 "type": {},
300 "name": {},
301 "size": {}
302 }
303 },
304 "email": "string",
305 "full_name": "string",
306 "state": "active"
307 },
308 "created_date": "2023-01-01T12:00:00.000Z",
309 "display_id": "string",
310 "modified_by": {
311 "display_id": "string",
312 "id": "string",
313 "display_name": "string",
314 "display_picture": {
315 "display_id": "string",
316 "id": "string",
317 "file": {
318 "type": {},
319 "name": {},
320 "size": {}
321 }
322 },
323 "email": "string",
324 "full_name": "string",
325 "state": "active"
326 },
327 "modified_date": "2023-01-01T12:00:00.000Z",
328 "removed_sla_metric_history": [
329 {
330 "metric_definition": {
331 "id": "string",
332 "display_id": "string",
333 "name": "string"
334 },
335 "removed_at": "2023-01-01T12:00:00.000Z",
336 "removed_by": {
337 "display_id": "string",
338 "id": "string",
339 "display_name": "string",
340 "display_picture": {
341 "display_id": {},
342 "id": {},
343 "file": {}
344 },
345 "email": "string",
346 "full_name": "string",
347 "state": "active"
348 }
349 }
350 ],
351 "sla": {
352 "id": "string",
353 "name": "string",
354 "status": "archived",
355 "display_id": "string",
356 "sla_type": "external"
357 },
358 "sla_policy_id": "string",
359 "stage": "string",
360 "status": "string"
361 },
362 "stage": "breached",
363 "target_time": "2023-01-01T12:00:00.000Z"
364 },
365 "sla_tracker": {
366 "id": "string",
367 "applies_to_type": "conversation",
368 "display_id": "string"
369 },
370 "source_channel": "string",
371 "source_channel_v2": {
372 "id": "string",
373 "display_id": "string"
374 },
375 "stage": {
376 "name": "string",
377 "notes": "string",
378 "ordinal": 1,
379 "stage": {
380 "id": "string",
381 "display_id": "string",
382 "name": "string"
383 },
384 "state": {
385 "id": "string",
386 "display_id": "string",
387 "is_final": true,
388 "name": "string"
389 }
390 },
391 "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
392 "subtype": "string",
393 "sync_metadata": {
394 "external_reference": "string",
395 "last_sync_in": {
396 "status": "failed",
397 "sync_date": "2023-01-01T12:00:00.000Z",
398 "sync_unit": {
399 "id": "string",
400 "display_id": "string",
401 "external_system_type": "adaas",
402 "is_archived": true,
403 "name": "string",
404 "sync_run": {
405 "mode": "initial",
406 "progress": {
407 "state": "completed"
408 }
409 },
410 "sync_type": "manual"
411 }
412 },
413 "last_sync_out": {
414 "status": "failed",
415 "sync_date": "2023-01-01T12:00:00.000Z",
416 "sync_unit": {
417 "id": "string",
418 "display_id": "string",
419 "external_system_type": "adaas",
420 "is_archived": true,
421 "name": "string",
422 "sync_run": {
423 "mode": "initial",
424 "progress": {
425 "state": "completed"
426 }
427 },
428 "sync_type": "manual"
429 }
430 },
431 "origin_system": "string"
432 },
433 "tags": [
434 {
435 "tag": {
436 "id": "string",
437 "name": "string",
438 "display_id": "string",
439 "style_new": {
440 "color": "string"
441 }
442 },
443 "value": "string"
444 }
445 ],
446 "title": "string"
447 }
448}
Gets the requested conversation's information.

Headers

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

Query parameters

idstringRequiredformat: "id"
The requested conversation's ID.

Response

The response to getting a conversation's information.
conversationobject

Errors

Was this page helpful?
Previous

Get Conversation (POST)

Next
Built with
The requested conversation's ID.
The response to getting a conversation's information.

Get Conversation (POST)

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