Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Intercom Conversations API

Manage conversations between contacts and admins.

Intercom Conversations API is one of 9 APIs that Intercom publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Conversations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 3 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2.15.

Requests are made against 3 base URLs: https://api.intercom.io, https://api.eu.intercom.io, https://api.au.intercom.io.

3 operations 2 paths 2 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.15
Base URL
https://api.intercom.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Intercom Conversations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Conversations 3

Manage conversations between contacts and admins.

GET
/conversations
List conversations
listConversations → 200
POST
/conversations
Create a conversation
createConversation body → 200
GET
/conversations/{conversation_id}
Retrieve a conversation
getConversation 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Conversation (8 properties), ConversationList (3 properties). Each schema is shown below with its type and property counts.

Conversation
object
8 properties
ConversationList
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

intercom-conversations-api-openapi.yml Raw ↑

Other APIs Intercom publishes across the network.

Intercom Admins API
Intercom Articles API
Intercom Companies API
Intercom Contacts API
Intercom Data Events API
Intercom Messages API
Intercom News API
Intercom Segments API