Skip to content

Intercom API (2.11)

The intercom API reference.

Download OpenAPI description
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/

Admins

Everything about your Admins

SchemasOperations

Articles

Everything about your Articles

SchemasOperations

Companies

Everything about your Companies

SchemasOperations

Contacts

Everything about your contacts

SchemasOperations

Conversations

Everything about your Conversations

SchemasOperations

Data Attributes

Everything about your Data Attributes

SchemasOperations

Data Events

Everything about your Data Events

SchemasOperations

Data Export

Everything about your Data Exports

SchemasOperations

Help Center

Everything about your Help Center

SchemasOperations

Messages

Everything about your messages

SchemasOperations
SchemasOperations
SchemasOperations

Segments

Everything about your Segments

SchemasOperations

Subscription Types

Everything about subscription types

SchemasOperations
Operations
SchemasOperations
SchemasOperations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

SchemasOperations

Visitors

Everything about your Visitors

Operations
Schemas

Contact Unarchived

unarchived contact object

typestringrequired

always contact

Value"contact"
Example: "contact"
idstringrequired

The unique identifier for the contact which is given by Intercom.

Example: "5ba682d23d7cf92bef87bfd4"
external_idstring or null

The unique identifier for the contact which is provided by the Client.

Example: "f3b87a2e09d514c6c2e79b9a"
archivedbooleanrequired

Whether the contact is archived or not.

Example: false
{ "type": "contact", "id": "5ba682d23d7cf92bef87bfd4", "external_id": "f3b87a2e09d514c6c2e79b9a", "archived": false }

Content Source List

typestringrequired
Value"content_source.list"
Example: "content_source.list"
total_countintegerrequired

The total number of content sources used by AI Agent in the conversation.

Example: 1
content_sourcesArray of objects(Content Source)required

The content sources used by AI Agent in the conversation.

content_sources[].​content_typestringrequired

The type of the content source.

Enum"file""article""external_content""content_snippet""workflow_connector_action"
Example: "content_snippet"
content_sources[].​urlstringrequired

The internal URL linking to the content source for teammates.

Example: "/fin-ai-agent/content?content=content_snippet&id=3234924"
content_sources[].​titlestringrequired

The title of the content source.

Example: "My internal content snippet"
content_sources[].​localestringrequired

The ISO 639 language code of the content source.

Example: "en"
{ "type": "content_source.list", "total_count": 1, "content_sources": [ {} ] }

Conversation attachment files

Properties of the attachment files in a conversation part

content_typestringrequired

The content type of the file

Example: "application/json"
datastringrequired

The base64 encoded file data.

Example: "ewogICJ0ZXN0IjogMQp9"
namestringrequired

The name of the file.

Example: "test.json"
{ "content_type": "application/json", "data": "ewogICJ0ZXN0IjogMQp9", "name": "test.json" }