The intercom API reference.
Home//
REST API Reference
/- Remove tag from a conversation
Conversation
Handling Event
Handling Event List
Teammate Reference
Add tag to a conversation
List all conversations
Creates a conversation
Retrieve a conversation
Update a conversation
Delete a conversation
Search conversations
Reply to a conversation
Manage a conversation
Attach a contact to a conversation
Detach a contact from a group conversation
Redact a conversation part
Convert a conversation to a ticket
Conversation handling events
Remove tag from a convers...
Intercom API (Unstable)
Download OpenAPI description
Overview
URL
License
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/
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
- The production API serverhttps://api.intercom.io/conversations/{conversation_id}/tags
- The european API serverhttps://api.eu.intercom.io/conversations/{conversation_id}/tags
- The australian API serverhttps://api.au.intercom.io/conversations/{conversation_id}/tags
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X POST \
https://api.intercom.io/conversations/64619700005694/tags \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: Unstable' \
-d '{
"id": 86,
"admin_id": 991267618
}'Response
application/json
{ "type": "tag", "id": "86", "name": "Manual tag" }
- The production API serverhttps://api.intercom.io/conversations/{conversation_id}/tags/{id}
- The european API serverhttps://api.eu.intercom.io/conversations/{conversation_id}/tags/{id}
- The australian API serverhttps://api.au.intercom.io/conversations/{conversation_id}/tags/{id}
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
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
}'Response
application/json
{ "type": "tag", "id": "89", "name": "Manual tag" }
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
- The production API serverhttps://api.intercom.io/conversations
- The european API serverhttps://api.eu.intercom.io/conversations
- The australian API serverhttps://api.au.intercom.io/conversations
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
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'Response
application/json
{ "type": "conversation.list", "pages": { "type": "pages", "page": 1, "per_page": 20, "total_pages": 1 }, "total_count": 1, "conversations": [ { … } ] }
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
Reporting Data Export
Everything about Reporting Data Export. See this article for details on using the data to generate various metrics.
Operations