Get Conversation (POST)

POST

Gets the requested conversation’s information.

Request

This endpoint expects an object.

idstringRequiredformat: "id"

The requested conversation’s ID.

Response

The response to getting a conversation’s information.

conversationobject

POST

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

200Successful

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

List Conversations

Up Next

Built with

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

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