The intercom API reference.
Download OpenAPI description
The production API server The european API serverhttps://api.eu.intercom.io/
The australian API serverhttps://api.au.intercom.io/
AdminsEverything about your Admins
AI ContentWith 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.",
ArticlesEverything about your Articles
Away Status ReasonsEverything about your Away Status Reasons
CompaniesEverything about your Companies
ConversationsEverything about your Conversations
Custom Channel EventsWith 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.
Custom Object InstancesNote: "Fin over API" is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.
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.
Data AttributesEverything about your Data Attributes
Data EventsEverything about your Data Events
Data ExportEverything about your Data Exports
Help CenterEverything about your Help Center
Internal ArticlesEverything about your Internal Articles
MacrosOperations related to saved replies (macros) in conversations
MessagesEverything about your messages
NewsEverything about your News
NotesEverything about your Notes
Reporting Data ExportEverything about Reporting Data Export
SegmentsEverything about your Segments
SegmentA segment is a group of your contacts defined by the rules that you set.
Value"segment"
Example: "segment"
The unique identifier representing the segment.
Example: "56203d253cba154d39010062"
The time the segment was created.
Example: 1394621988
The time the segment was updated.
Example: 1394622004
Type of the contact: contact (lead) or user.
Enum"contact""user"
Example: "contact"
The number of items in the user segment. It's returned when include_count=true is included in the request.
Example: 3
Request{ "type": "segment", "id": "56203d253cba154d39010062", "name": "Active", "created_at": 1394621988, "updated_at": 1394622004, "person_type": "contact", "count": 3 }
You can fetch a list of all segments.
QueryIt includes the count of contacts that belong to each segment.
Example: include_count=true
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
https://api.intercom.io/segments
https://api.eu.intercom.io/segments
https://api.au.intercom.io/segments
curl -i -X GET \ 'https://api.intercom.io/segments?include_count=true' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: Unstable'Bodyapplication/json
Value"segment.list"
Example: "segment.list"
segmentsArray of objects(Segment)A list of Segment objects
A pagination object, which may be empty, indicating no further pages to fetch.
Request{ "type": "segment.list", "segments": [ { … }, { … } ] }
You can fetch the details of a single segment.
PathThe unique identified of a given segment.
Example: 123
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
https://api.intercom.io/segments/{id}
https://api.eu.intercom.io/segments/{id}
https://api.au.intercom.io/segments/{id}
curl -i -X GET \ https://api.intercom.io/segments/123 \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: Unstable'Bodyapplication/json
Value"segment"
Example: "segment"
The unique identifier representing the segment.
Example: "56203d253cba154d39010062"
The time the segment was created.
Example: 1394621988
The time the segment was updated.
Example: 1394622004
Type of the contact: contact (lead) or user.
Enum"contact""user"
Example: "contact"
The number of items in the user segment. It's returned when include_count=true is included in the request.
Example: 3
Subscription Types{ "type": "segment", "id": "6762f25f1bb69f9f2193bc26", "name": "John segment", "created_at": 1734537823, "updated_at": 1734537823, "person_type": "user" }
Everything about subscription types
TeamsEverything about your Teams
Ticket StatesEverything about your ticket states
Ticket Type AttributesEverything about your ticket type attributes
Ticket TypesEverything about your ticket types
TicketsEverything about your tickets
VisitorsEverything about your Visitors
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4