The intercom API reference.
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
NoteNotes allow you to annotate and comment on your contacts.
String representing the object's type. Always has the value note
.
Example: "note"
created_atinteger(timestamp)The time the note was created.
Example: 1674589321
Represents the contact that the note was created about.
authorobject or null(Admin)Admins are teammate accounts that have access to a workspace.
The body text of the note.
Example: "<p>Text for the note.</p>"
Request{ "type": "note", "id": "17495962", "created_at": 1674589321, "contact": { "type": "string", "id": "214656d0c743eafcfde7f248" }, "author": { "type": "admin", "id": "1295", "name": "Joe Example", "email": "jdoe@example.com", "job_title": "Associate", "away_mode_enabled": false, "away_mode_reassign": false, "away_status_reason_id": 12345, "has_inbox_seat": true, "team_ids": [ … ], "avatar": "https://picsum.photos/200/300", "team_priority_level": { … } }, "body": "<p>Text for the note.</p>" }
You can fetch a list of notes that are associated to a contact.
PathThe unique identifier of a contact.
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
curl -i -X GET \ 'https://api.intercom.io/contacts/{id}/notes' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: Unstable'Bodyapplication/json
String representing the object's type. Always has the value list
.
Example: "list"
dataArray of objects(Note)A count of the total number of notes.
Example: 1
pagesobject or null(Cursor based pages)Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
Request{ "type": "list", "data": [ { … }, { … }, { … } ], "total_count": 3, "pages": { "type": "pages", "next": null, "page": 1, "per_page": 50, "total_pages": 1 } }
You can add a note to a single contact.
PathThe unique identifier of a given contact.
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
Bodyapplication/jsonThe unique identifier of a given contact.
Example: "123"
The unique identifier of a given admin.
Example: "123"
curl -i -X POST \ https://api.intercom.io/contacts/123/notes \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: Unstable' \ -d '{ "contact_id": "6762f0ad1bb69f9f2193bb62", "admin_id": 991267583, "body": "Hello" }'Bodyapplication/json
String representing the object's type. Always has the value note
.
Example: "note"
created_atinteger(timestamp)The time the note was created.
Example: 1674589321
Represents the contact that the note was created about.
authorobject or null(Admin)Admins are teammate accounts that have access to a workspace.
The body text of the note.
Example: "<p>Text for the note.</p>"
Request{ "type": "note", "id": "31", "created_at": 1734537390, "contact": { "type": "contact", "id": "6762f0ad1bb69f9f2193bb62" }, "author": { "type": "admin", "id": "991267583", "name": "Ciaran124 Lee", "email": "admin124@email.com", "away_mode_enabled": false, "away_mode_reassign": false }, "body": "<p>Hello</p>" }
You can fetch the details of a single note.
PathThe unique identifier of a given note
Example: 1
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
curl -i -X GET \ https://api.intercom.io/notes/1 \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: Unstable'Bodyapplication/json
String representing the object's type. Always has the value note
.
Example: "note"
created_atinteger(timestamp)The time the note was created.
Example: 1674589321
Represents the contact that the note was created about.
authorobject or null(Admin)Admins are teammate accounts that have access to a workspace.
The body text of the note.
Example: "<p>Text for the note.</p>"
Reporting Data Export{ "type": "note", "id": "34", "created_at": 1733846617, "contact": { "type": "contact", "id": "6762f2591bb69f9f2193bc1f" }, "author": { "type": "admin", "id": "991267864", "name": "Ciaran346 Lee", "email": "admin346@email.com", "away_mode_enabled": false, "away_mode_reassign": false }, "body": "<p>This is a note.</p>" }
Everything about Reporting Data Export
SegmentsEverything about your Segments
Subscription TypesEverything 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