Skip to content
Home/
REST API Reference
/
/
List all conversations

Intercom API (Unstable)

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

SchemasOperations

AI Content

With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.

 

External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.

 

Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.

 

You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",

SchemasOperations

Articles

Everything about your Articles

SchemasOperations

Away Status Reasons

Everything about your Away Status Reasons

Operations

Brands

Everything about your Brands

SchemasOperations

Calls

Everything about your Calls

SchemasOperations

Companies

Everything about your Companies

SchemasOperations

Contacts

Everything about your contacts

SchemasOperations

Conversations

Everything about your Conversations

SchemasOperations

Remove tag from a conversation

Request

You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.

Security
bearerAuth
Path
conversation_idstringrequired

conversation_id

Example: 64619700005694
idstringrequired

id

Example: 7522907
Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default Unstable
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: Unstable
Bodyapplication/json
admin_idstringrequired

The unique identifier for the admin which is given by Intercom.

Example: "123"
curl -i -X DELETE \
  https://api.intercom.io/conversations/64619700005694/tags/7522907 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: Unstable' \
  -d '{
    "admin_id": 991267622
  }'

Responses

successful

Bodyapplication/json
typestring

value is "tag"

Example: "tag"
idstring

The id of the tag

Example: "123456"
namestring

The name of the tag

Example: "Test tag"
applied_atinteger(date-time)

The time when the tag was applied to the object

Example: 1663597223
applied_byobject(Reference)

reference to another object

Response
application/json
{
  "type": "tag",
  "id": "89",
  "name": "Manual tag"
}

List all conversations

Request

You can fetch a list of all conversations.

You can optionally request the result page size and the cursor to start after to fetch the result.

Pagination

You can use pagination to limit the number of results returned. The default is 20 results per page. See the pagination section for more details on how to use the starting_after param.

Security
bearerAuth
Query
per_pageinteger<= 150

How many results per page

Default 20
starting_afterstring

String used to get the next page of conversations.

Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default Unstable
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: Unstable
curl -i -X GET \
  'https://api.intercom.io/conversations?per_page=20&starting_after=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Unstable'

Responses

successful

Bodyapplication/json
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.

Response
application/json
{
  "type": "conversation.list",
  "pages": {
    "type": "pages",
    "page": 1,
    "per_page": 20,
    "total_pages": 1
  },
  "total_count": 1,
  "conversations": [
    { … }
  ]
}

Creates a conversation

Request

You can create a conversation that has been initiated by a contact (ie. user or lead).

Sending for visitors

You can also send a message from a visitor by specifying their user_id or id value in the from field, along with a type field value of contact. This visitor will be automatically converted to a contact with a lead role once the conversation is created.

This will return the Message model that has been created.

Security
bearerAuth
Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default Unstable
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: Unstable
Bodyapplication/json
fromobjectrequired
from.​typestringrequired

The role associated to the contact - user or lead.

Enum"lead""user""contact"
Example: "user"
from.​idstring(uuid)= 24 charactersrequired

The identifier for the contact which is given by Intercom.

Example: "536e564f316c83104c000020"
bodystringrequired

The content of the message. HTML is not supported.

Example: "Hello"
created_atinteger(date-time)

The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom.

Example: 1671028894
message_typestring

The kind of message being created. Values: inapp (in-app messaging), email, sms, whatsapp, or facebook.

Enum"inapp""email""sms""whatsapp""facebook"
Example: "inapp"
curl -i -X POST \
  https://api.intercom.io/conversations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: Unstable' \
  -d '{
    "from": {
      "type": "user",
      "id": "6762f11b1bb69f9f2193bba3"
    },
    "body": "Hello there"
  }'

Responses

conversation created

Bodyapplication/json
typestringrequired

The type of the message

Example: "user_message"
idstringrequired

The id representing the message.

Example: "1488971108"
created_atinteger(date-time)required

The time the conversation was created.

Example: 1667560812
subjectstring

The subject of the message. Only present if message_type: email.

Example: "Greetings"
bodystringrequired

The message body, which may contain HTML.

Example: "Hello"
message_typestringrequired

The type of message that was sent. Can be email, inapp, facebook, sms or whatsapp.

Enum"email""inapp""facebook""sms""whatsapp"
Example: "inapp"
conversation_idstring

The associated conversation_id

Example: "64619700005570"
Response
application/json
{
  "type": "user_message",
  "id": "403918330",
  "created_at": 1734537501,
  "body": "Hello there",
  "message_type": "inapp",
  "conversation_id": "499"
}

Custom Object Instances

Everything about your Custom Object instances.

Permission Requirements

From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.

SchemasOperations

Data Attributes

Everything about your Data Attributes

SchemasOperations

Data Events

Everything about your Data Events

SchemasOperations

Data Export

Everything about your Data Exports

SchemasOperations

Emails

Everything about your Emails

SchemasOperations

Help Center

Everything about your Help Center

SchemasOperations

Internal Articles

Everything about your Internal Articles

SchemasOperations

Jobs

Everything about jobs

SchemasOperations

Macros

Operations related to saved replies (macros) in conversations

SchemasOperations

Messages

Everything about your messages

SchemasOperations

News

Everything about your News

SchemasOperations

Notes

Everything about your Notes

SchemasOperations

Reporting Data Export

Everything about Reporting Data Export. See this article for details on using the data to generate various metrics.

Operations

Segments

Everything about your Segments

SchemasOperations

Subscription Types

Everything about subscription types

SchemasOperations

Switch

Everything about Switch

Operations

Tags

Everything about tags

SchemasOperations

Teams

Everything about your Teams

SchemasOperations

Ticket States

Everything about your ticket states

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

SchemasOperations

Visitors

Everything about your Visitors

Operations

Workflows

Export workflow configurations from your workspace.

Operations

Models

Schemas

Custom Channel Events

Operations

WhatsApp

Operations