Skip to content

Intercom API (2.10)

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

Ticket List

Tickets are how you track requests from your users.

typestring

Always ticket.list

Value"ticket.list"
Example: "ticket.list"
ticketsArray of objects or null(Ticket)

The list of ticket objects

total_countinteger

A count of the total number of objects.

Example: 12345
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": "ticket.list", "tickets": [ {} ], "total_count": 12345, "pages": { "type": "pages", "page": 1, "next": {}, "per_page": 2, "total_pages": 13 } }

Ticket part author

The author that wrote or triggered the part. Can be a bot, admin, team or user.

typestring

The type of the author

Enum"admin""bot""team""user"
Example: "admin"
idstring

The id of the author

Example: "274"
namestring or null

The name of the author

Example: "Operator"
emailstring(email)

The email of the author

Example: "operator+abcd1234@intercom.io"
{ "type": "admin", "id": "274", "name": "Operator", "email": "operator+abcd1234@intercom.io" }

Ticket Parts

A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.

typestring
Value"ticket_part.list"
Example: "ticket_part.list"
ticket_partsArray of objects(Tickt Parts)

A list of Ticket Part objects for each ticket. There is a limit of 500 parts.

total_countinteger
Example: 2
{ "type": "ticket_part.list", "ticket_parts": [ {} ], "total_count": 2 }