List all conversations
Example Request & Response
$ curl \"https://api.intercom.io/conversations?order=desc&sort=updated_at" \ -H 'Authorization:Bearer <Your access token>' \ -H 'Accept:application/json'
HTTP/1.1 200 OK { "type": "conversation.list", "conversations": [ { "type": "conversation", "id": "1911149811", "created_at": 1539897198, "updated_at": 1540393270, "source": { "attachments": [], "author": { "id": "5bc8f7421ae2d96695c18a", "type": "lead" }, "body": "<p>Hi</p>", "delivered_as": "customer_initiated", "id": "269650473", "subject": "", "type": "conversation", "url": "https://intercom-survey-app.glitch.me/" }, "contacts": [ { "id": "5bc8f7ae2d96695c18a", "type": "lead" } ], "teammates": [ { "id": "814860", "type": "admin", "name": "Mark Strong", "email": "mk@acmeinc.org" } ], "assignee": { { "id": "814860", "type": "admin", "name": "Mark Strong", "email": "mk@acmeinc.org" } }, "open": true, "state": "open", "read": true, "waiting_since": 64654125776 "snoozed_until": null, "tags": { "tags": [], "type": "tag.list", }, "first_contact_reply": { "created_at": 1539897198 "type": "conversation", "url": "https://intercom-survey-app.glitch.me/" }, "priority": "not_priority", "sla_applied": { "sla_name": "VIP customer <5m", "sla_status": "missed", }, "conversation_rating": { "created_at": null, "contact": { "id": null, "type": null }, "rating": null, "remark": null, "teammate": { "id": null, "type": null, "name": null, "email": null } }, "statistics": { "time_to_assignment": 2310, "time_to_admin_reply": 2408, "time_to_first_close": 4915 , "time_to_last_close": 5125, "median_time_to_reply": 321, "first_contacat_reply_at": 1539897200, "first_assignment_at": 1539897200, "first_admin_reply_at": 1539897200, "first_close_at": 1539897200, "last_assignment_at": 1539897200, "last_assignment_admin_reply_at": 1539897200, "last_contact_reply_at": 1539897200, "last_admin_reply_at": 1539897200, "last_close_at": 1539897200, "last_closed_by": { "type": "admin", "id": "325432652", "name": "Tom Smith", "email": "tom@example.com" }, "count_reopens": 3, "count_assignments": 2, "count_conversation_parts": 67 }, # list of conversaionts ], "pages": { "next": "https://api.intercom.io/conversations?per_page=20&page=2", "page": 1, "per_page": 20, "total_pages": 77, "type": "pages" } }
intercom.conversations.find_all(:type => 'admin', :id => 25, :open => true)
<?php
$intercom->conversations->getConversations([
"type" => "admin",
"admin_id" => "891290",
"open" => false
]);
?>
Map<String, String> params = Maps.newHashMap(); params.put("type", "admin"); params.put("admin_id", "1"); ConversationCollection conversations = Conversation.list(params); while (conversations.hasNext()) { Conversation conversation = conversations.next(); }
You can fetch a list of all conversations.
Request Query Parameters
| Parameter | Type | Required? | Description |
|---|---|---|---|
| order | String | No | Return the conversations in ascending (asc) or descending (desc) order. Defaults to desc. If you provide an invalid value, we default to asc. |
| sort | String | No | Return the conversation sorted by their created_at, updated_at, or waiting_since timestamp values. Defaults to updated_at. |
Conversations not showing with waiting_since sorting
If a teammate was the last person to reply, or the conversation is closed, then those conversations will not show up on this list. This is to ensure you have an easy way of identifying and prioritizing those customers who have been waiting longest.
Response
A paginated list of Conversations is returned, without the conversation_parts object.
Retrieving Conversation Parts
You must retrieve a single conversation using the conversation's id to return a conversation with the conversation_part array and objects included.