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
MessagesEverything about your messages
NewsEverything about your News
NotesEverything about your Notes
Reporting Data ExportEverything 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
RequestYou can get a list of all ticket types for a workspace.
Headers Intercom-Versionstring(intercom_version)Intercom API version.
By default, it's equal to the version set in the app package.
Default 2.14
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.14
curl -i -X GET \ https://api.intercom.io/ticket_types \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.14'Bodyapplication/json
String representing the object's type. Always has the value list
.
Example: "list"
dataArray of objects or null(Ticket Type)A list of ticket_types associated with a given workspace.
Request{ "type": "list", "data": [ { β¦ } ] }
You can create a new ticket type.
Headers Intercom-Versionstring(intercom_version)π Creating ticket types.
Every ticket type will be created with two default attributes: default_title and default_description. For the
icon
propery, use an emoji from Twemoji Cheatsheet
Intercom API version.
By default, it's equal to the version set in the app package.
Default 2.14
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.14
Bodyapplication/jsonThe name of the ticket type.
Example: "Bug"
The description of the ticket type.
Example: "Used for tracking bugs"
Category of the Ticket Type.
Enum"Customer""Back-office""Tracker"
Example: "Customer"
The icon of the ticket type.
Default "ποΈ"
Example: "π"
Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.
Default false
Example: false
curl -i -X POST \ https://api.intercom.io/ticket_types \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.14' \ -d '{ "name": "Customer Issue", "description": "Customer Report Template", "icon": "ποΈ", "category": "Customer" }'Bodyapplication/json
String representing the object's type. Always has the value ticket_type
.
Example: "ticket_type"
The id representing the ticket type.
Example: "1295"
Category of the Ticket Type.
Enum"Customer""Back-office""Tracker"
Example: "Customer"
The name of the ticket type
Example: "Bug"
The description of the ticket type
Example: "A bug that has been reported."
The icon of the ticket type
Example: "π"
The id of the workspace that the ticket type belongs to.
Example: "ecahpwf5"
ticket_type_attributesobject(Ticket Type Attributes)A list of attributes associated with a given ticket type.
ticket_statesobject(Ticket States)A list of ticket states associated with a given ticket type.
Whether the ticket type is archived or not.
Example: false
created_atinteger(timestamp)The date and time the ticket type was created.
updated_atinteger(timestamp)The date and time the ticket type was last updated.
Request{ "type": "ticket_type", "id": "70", "name": "Customer Issue", "description": "Customer Report Template", "icon": "ποΈ", "workspace_id": "this_is_an_id652_that_should_be_at_least_", "archived": false, "created_at": 1734537869, "updated_at": 1734537869, "is_internal": false, "ticket_type_attributes": { "type": "list", "data": [ β¦ ] }, "category": "Customer", "ticket_states": { "type": "list", "data": [ β¦ ] } }
You can fetch the details of a single ticket type.
PathThe unique identifier for the ticket type which is given by Intercom.
Headers Intercom-Versionstring(intercom_version)Intercom API version.
By default, it's equal to the version set in the app package.
Default 2.14
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.14
curl -i -X GET \ 'https://api.intercom.io/ticket_types/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.14'Bodyapplication/json
String representing the object's type. Always has the value ticket_type
.
Example: "ticket_type"
The id representing the ticket type.
Example: "1295"
Category of the Ticket Type.
Enum"Customer""Back-office""Tracker"
Example: "Customer"
The name of the ticket type
Example: "Bug"
The description of the ticket type
Example: "A bug that has been reported."
The icon of the ticket type
Example: "π"
The id of the workspace that the ticket type belongs to.
Example: "ecahpwf5"
ticket_type_attributesobject(Ticket Type Attributes)A list of attributes associated with a given ticket type.
ticket_statesobject(Ticket States)A list of ticket states associated with a given ticket type.
Whether the ticket type is archived or not.
Example: false
created_atinteger(timestamp)The date and time the ticket type was created.
updated_atinteger(timestamp)The date and time the ticket type was last updated.
Request{ "type": "ticket_type", "id": "72", "name": "Bug Report", "description": "Bug Report Template", "icon": "ποΈ", "workspace_id": "this_is_an_id656_that_should_be_at_least_", "archived": false, "created_at": 1734537870, "updated_at": 1734537870, "is_internal": false, "ticket_type_attributes": { "type": "list", "data": [ β¦ ] }, "category": "Customer", "ticket_states": { "type": "list", "data": [ β¦ ] } }
You can update a ticket type.
Pathπ Updating a ticket type.
For the
icon
propery, use an emoji from Twemoji Cheatsheet
The unique identifier for the ticket type which is given by Intercom.
Headers Intercom-Versionstring(intercom_version)Intercom API version.
By default, it's equal to the version set in the app package.
Default 2.14
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.14
Bodyapplication/jsonThe name of the ticket type.
Example: "Bug"
The description of the ticket type.
Example: "A bug has been occured"
Category of the Ticket Type.
Enum"Customer""Back-office""Tracker"
Example: "Customer"
The icon of the ticket type.
Default "ποΈ"
Example: "π"
The archived status of the ticket type.
Example: false
Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.
Default false
Example: false
curl -i -X PUT \ 'https://api.intercom.io/ticket_types/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.14' \ -d '{ "name": "Bug Report 2" }'Bodyapplication/json
String representing the object's type. Always has the value ticket_type
.
Example: "ticket_type"
The id representing the ticket type.
Example: "1295"
Category of the Ticket Type.
Enum"Customer""Back-office""Tracker"
Example: "Customer"
The name of the ticket type
Example: "Bug"
The description of the ticket type
Example: "A bug that has been reported."
The icon of the ticket type
Example: "π"
The id of the workspace that the ticket type belongs to.
Example: "ecahpwf5"
ticket_type_attributesobject(Ticket Type Attributes)A list of attributes associated with a given ticket type.
ticket_statesobject(Ticket States)A list of ticket states associated with a given ticket type.
Whether the ticket type is archived or not.
Example: false
created_atinteger(timestamp)The date and time the ticket type was created.
updated_atinteger(timestamp)The date and time the ticket type was last updated.
Tickets{ "type": "ticket_type", "id": "74", "name": "Bug Report 2", "description": "Bug Report Template", "icon": "ποΈ", "workspace_id": "this_is_an_id660_that_should_be_at_least_", "archived": false, "created_at": 1734537873, "updated_at": 1734537874, "is_internal": false, "ticket_type_attributes": { "type": "list", "data": [ β¦ ] }, "category": "Customer", "ticket_states": { "type": "list", "data": [ β¦ ] } }
Everything 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