Skip to content
Home/
REST API Reference
/
/
Linked Object

Intercom API (2.10)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL

https://developers.intercom.com

License

MIT

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

News

Everything about your News

SchemasOperations

Notes

Everything about your Notes

SchemasOperations

Segments

Everything about your Segments

SchemasOperations

Subscription Types

Everything about subscription types

SchemasOperations

Switch

Everything about Switch

Operations

Tags

Everything about tags

SchemasOperations

Teams

Everything about your Teams

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

Models

Schemas

intercom_version

Intercom API version.
By default, it's equal to the version set in the app package.

string(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default "2.10"
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
"2.10"

Linked Object

A linked conversation or ticket.

typestring

ticket or conversation

Enum"ticket""conversation"
Example: "ticket"
idstring

The ID of the linked object

Example: "7583"
categorystring or null

Category of the Linked Ticket Object.

Enum"Customer""Back-office""Tracker"null
Example: "Customer"
{
  "type": "ticket",
  "id": "7583",
  "category": "Customer"
}

Linked Objects

An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.

typestring

Always list.

Value"list"
Example: "list"
total_countinteger

The total number of linked objects.

Example: 100
has_moreboolean

Whether or not there are more linked objects than returned.

Example: false
dataArray of objects(Linked Object)

An array containing the linked conversations and linked tickets.

{
  "type": "list",
  "total_count": 100,
  "has_more": false,
  "data": [
    { … }
  ]
}