Intercom API (Unstable)

The intercom API reference.

Download OpenAPI description
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

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.",

Operations

Articles

Everything about your Articles

Operations

Internal Articles

Everything about your Internal Articles

Operations

Away Status Reasons

Everything about your away status reasons

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Custom Channel Events

With the closed beta "Custom Channel" integration, you can bring Fin and Intercom capabilities to your own platform via API, enabling powerful custom integrations.

Intercom treats your integration like any other Intercom channel, allowing your application and Intercom to exchange events seamlessly. This makes it possible, for example, for your users to interact with Fin directly within your own application’s UI.

Note: If you are interested in joining our closed beta and have a use case to integrate with "Fin over API", please reach out to your account manager or our support team for further information.

Operations

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.

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

Jobs

Everything about jobs

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 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

Operations

Visitors

Everything about your Visitors

Operations

Models

Reporting Data Export

Operations

WhatsApp

Operations

Get statuses of all messages sent based on the specified ruleset_id

Request

Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.

This endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing information about delivery state and related message details.

Security
bearerAuth
Query
ruleset_idstringrequired

The unique identifier for the set of messages to check status for

per_pageinteger<= 100

Number of results per page (default 50, max 100)

Default 50
starting_afterstring

Cursor for pagination, used to fetch the next page of results

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/messages/status?per_page=50&ruleset_id=string&starting_after=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Unstable'

Responses

Successful response

Bodyapplication/json
typestringrequired
Value"list"
ruleset_idstringrequired

The provided ruleset ID

pagesobjectrequired
pages.​typestringrequired
Value"pages"
pages.​per_pageintegerrequired

Number of results per page

pages.​total_pagesintegerrequired

Total number of pages

pages.​nextobject or null

Information for fetching next page (null if no more pages)

total_countintegerrequired

Total number of events

eventsArray of objectsrequired
events[].​idstringrequired

Event ID

events[].​conversation_idstringrequired

ID of the conversation

events[].​statusstringrequired

Current status of the message

Enum"sent""delivered""read""failed"
events[].​typestringrequired

Event type

Value"broadcast_outbound"
events[].​created_atintegerrequired

Creation timestamp

events[].​updated_atintegerrequired

Last update timestamp

events[].​whatsapp_message_idstringrequired

WhatsApp's message identifier

events[].​template_namestring

Name of the WhatsApp template used

Response
application/json
{ "type": "list", "ruleset_id": 12345, "pages": { "type": "pages", "per_page": 50, "total_pages": 3, "next": {} }, "total_count": 125, "events": [ {}, {} ] }