Home
/
REST API Reference
/
Models
/
Conversation List

Intercom API (2.10)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL https://developers.intercom.com
License MIT
Languages
Servers
The production API server
https://api.intercom.io/
The european API server
https://api.eu.intercom.io/
The australian API server
https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models

First contact reply

An object containing information on the first users message. For a contact initiated message this will represent the users original message.

created_atinteger(date-time)
Example: 1663597223
typestring
Example: "conversation"
urlstring or null
Example: "https://developers.intercom.com/"
{
  "created_at": 1663597223,
  "type": "conversation",
  "url": "https://developers.intercom.com/"
}

Conversation List

Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.

typestring

Always conversation.list

Value"conversation.list"
Example: "conversation.list"
conversationsArray of objects(Conversation)

The list of conversation objects

total_countinteger

A count of the total number of objects.

Example: 12345
pagesobject or null(Cursor based pages)

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

{
  "type": "conversation.list",
  "conversations": [
    { … }
  ],
  "total_count": 12345,
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  }
}

Conversation Part

A Conversation Part represents a message in the conversation.

typestring

Always conversation_part

Example: "conversation_part"
idstring

The id representing the conversation part.

Example: "3"
part_typestring

The type of conversation part.

Example: "comment"
bodystring or null

The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.

Example: "<p>Okay!</p>"
created_atinteger(date-time)

The time the conversation part was created.

Example: 1663597223
updated_atinteger(date-time)

The last time the conversation part was updated.

Example: 1663597260
notified_atinteger(date-time)

The time the user was notified with the conversation part.

Example: 1663597260
assigned_toobject(Reference)

reference to another object

authorobject(Conversation part author)

The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.

attachmentsArray of objects(Conversation part attachments)

A list of attachments for the part.

external_idstring or null

The external id of the conversation part

Example: "abcd1234"
redactedboolean

Whether or not the conversation part has been redacted.

Example: false
{
  "type": "conversation_part",
  "id": "3",
  "part_type": "comment",
  "body": "<p>Okay!</p>",
  "created_at": 1663597223,
  "updated_at": 1663597260,
  "notified_at": 1663597260,
  "assigned_to": {
    "type": "contact",
    "id": "1a2b3c"
  },
  "author": {
    "type": "admin",
    "id": "274",
    "name": "Operator",
    "email": "operator+abcd1234@intercom.io"
  },
  "attachments": [
    { … }
  ],
  "external_id": "abcd1234",
  "redacted": false
}