Skip to content

Intercom API (2.9)

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

Paginated Response

Paginated Response

typestring

The type of object

Enum"list""conversation.list"
Example: "list"
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.

total_countinteger

A count of the total number of objects.

Example: 1
dataArray of News Item (object) or Newsfeed (object)

An array of Objects

{ "type": "list", "pages": { "type": "pages", "page": 1, "next": {}, "per_page": 2, "total_pages": 13 }, "total_count": 1, "data": [ {} ] }

Part attachment

The file attached to a part

typestring

The type of attachment

Example: "upload"
namestring

The name of the attachment

Example: "example.png"
urlstring

The URL of the attachment

Example: "https://picsum.photos/200/300"
content_typestring

The content type of the attachment

Example: "image/png"
filesizeinteger

The size of the attachment

Example: 100
widthinteger

The width of the attachment

Example: 100
heightinteger

The height of the attachment

Example: 100
{ "type": "upload", "name": "example.png", "url": "https://picsum.photos/200/300", "content_type": "image/png", "filesize": 100, "width": 100, "height": 100 }