The intercom API reference.
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.",
Operations
Custom Channel Events
With the "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: "Fin over API" is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.
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
Email Setting
Represents a sender email address configuration
Unix timestamp of last forwarded email received (null if never)
Example: 1710498600
{ "type": "email_setting", "id": "10", "email": "support@company.com", "verified": true, "domain": "company.com", "brand_id": "10", "forwarding_enabled": true, "forwarded_email_last_received_at": 1710498600, "created_at": 1692530400, "updated_at": 1710498600 }
- The production API server
https://api.intercom.io/emails
- The european API server
https://api.eu.intercom.io/emails
- The australian API server
https://api.au.intercom.io/emails
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X GET \
https://api.intercom.io/emails \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: Unstable'Response
application/json
{ "type": "list", "data": [ { … }, { … } ] }
- The production API server
https://api.intercom.io/emails/{id}
- The european API server
https://api.eu.intercom.io/emails/{id}
- The australian API server
https://api.au.intercom.io/emails/{id}
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X GET \
'https://api.intercom.io/emails/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: Unstable'Response
application/json
{ "type": "email_setting", "id": "10", "email": "support@company.com", "verified": true, "domain": "company.com", "brand_id": "15", "forwarding_enabled": true, "forwarded_email_last_received_at": 1710498600, "created_at": 1692530400, "updated_at": 1710498600 }