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

Contact Deleted

deleted contact object

typestring

always contact

Value"contact"
Example: "contact"
idstring

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"
deletedboolean

Whether the contact is deleted or not.

Example: true
{ "type": "contact", "id": "5ba682d23d7cf92bef87bfd4", "external_id": "f3b87a2e09d514c6c2e79b9a", "deleted": true }

Contact List

Contacts are your users in Intercom.

typestring

Always list

Value"list"
Example: "list"
dataArray of objects(Contact)

The list of contact objects

total_countinteger

A count of the total number of objects.

Example: 100
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.

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

Contact Location

An object containing location meta data about a Intercom contact.

typestring or null

Always location

Example: "location"
countrystring or null

The country that the contact is located in

Example: "Ireland"
regionstring or null

The overal region that the contact is located in

Example: "Dublin"
citystring or null

The city that the contact is located in

Example: "Dublin"
{ "type": "location", "country": "Ireland", "region": "Dublin", "city": "Dublin" }