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 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 }

A Ticket Part representing a note, comment, or quick_reply on a ticket

A Ticket Part representing a note, comment, or quick_reply on a ticket

typestring

Always ticket_part

Value"ticket_part"
Example: "ticket_part"
idstring

The id representing the part.

Example: "3"
part_typestring

Type of the part

Enum"note""comment""quick_reply"
Example: "note"
bodystring or null

The message body, which may contain HTML.

Example: "<p>Okay!</p>"
created_atinteger(date-time)

The time the note was created.

Example: 1663597223
updated_atinteger(date-time)

The last time the note was updated.

Example: 1663597260
authorobject(Ticket part author)

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

attachmentsArray of objects(Ticket part attachments)

A list of attachments for the part.

redactedboolean

Whether or not the ticket part has been redacted.

Example: false
{ "type": "ticket_part", "id": "3", "part_type": "note", "body": "<p>Okay!</p>", "created_at": 1663597223, "updated_at": 1663597260, "author": { "type": "admin", "id": "274", "name": "Operator", "email": "operator+abcd1234@intercom.io" }, "attachments": [ {} ], "redacted": false }

Ticket Attributes

The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are _default_title_ and _default_description_. When setting ticket type attributes of the list attribute type, the key should be the attribute name and the value of the attribute should be the list item id, obtainable by listing the ticket type. For example, if the ticket type has an attribute called priority of type list, the key should be priority and the value of the attribute should be the guid of the list item (e.g. de1825a0-0164-4070-8ca6-13e22462fa7e).

property name*(string or null) or number or boolean or Array of arraysadditional property
Any of:
string or null
{ "_default_title_": "Found a bug", "_default_description_": "The button is not working" }