Intercom API Documentation
This is the complete API documentation for connecting to the Intercom API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Intercom: Manage contacts, conversations, tickets, and customer messaging. Keep reading to get started.
Quickstart
Before you run your first Intercom request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Intercom connection — create or choose one in Connections. Note its
connectionId.
Every Intercom action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/intercom/latest/actions/{actionSlug}You need a MindCloud API Key and a Intercom connection. Then call an action such as Get Contact:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/intercom/latest/actions/get-contact" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Intercom account that should run the action. MindCloud stores and refreshes the Intercom credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
How to set up your connection?
Use this connection only for your own Intercom workspace. If you need to access another company’s Intercom data, use OAuth instead.
- Open the Intercom Developer Hub
Sign in to the Intercom workspace you want to connect, then open the Developer Hub for that workspace.
- Open your Intercom app
Go to Your Apps and select the app you want to use for this private connection.
- Find the Access Token
Open the Authentication section of the app and copy the Access Token shown there. Intercom provides this token when you create an app on your workspace.
- Paste the token into the connection form
Return to the connection form and paste the value into the Access Token field.
Intercom actions
All 31 published actions for this Intercom version. Each page documents the endpoint, arguments, and response controls.
- PUTArchive Contact
- PUTAttach Contact To Conversation
- PUTConvert Conversation To Ticket
- POSTCreate Contact
- POSTCreate Conversation
- POSTCreate Ticket
- DELETEDelete Contact
- DELETEDelete Conversation
- DELETEDelete Ticket
- GETGet Contact
- GETGet Contact By External ID
- GETGet Ticket
- GETList Contact Companies
- GETList Contact Segments
- GETList Contact Subscriptions
- GETList Contact Tags
- GETList Contacts
- GETList Conversations
- PUTManage Conversation Part
- PUTMerge Contact
- PUTRedact Conversation
- PUTReply Conversation
- PUTReply Ticket
- GETRetrieve Conversation
- GETSearch Contacts
- GETSearch Conversations
- GETSearch Tickets
- PUTUnarchive Contact
- PUTUpdate Contact
- PUTUpdate Conversation
- PUTUpdate Ticket
Related apps
More Support apps on the Universal API, behind the same REST shape. Or browse all apps.