Skip to content
Home
/
REST API Reference
/
Models
/
Contacts

Intercom API (2.11)

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

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Conversation attachment files

Properties of the attachment files in a conversation part

content_typestringrequired

The content type of the file

Example: "application/json"
datastringrequired

The base64 encoded file data.

Example: "ewogICJ0ZXN0IjogMQp9"
namestringrequired

The name of the file.

Example: "test.json"
{
  "content_type": "application/json",
  "data": "ewogICJ0ZXN0IjogMQp9",
  "name": "test.json"
}

Contacts

The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.

typestringrequired
Value"contact.list"
Example: "contact.list"
contactsArray of objects(Contact Reference)required

The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.

contacts[].​typestringrequired

always contact

Value"contact"
Example: "contact"
contacts[].​idstringrequired

The unique identifier for the contact which is given by Intercom.

Example: "5ba682d23d7cf92bef87bfd4"
contacts[].​external_idstring or null

The unique identifier for the contact which is provided by the Client.

Example: "f3b87a2e09d514c6c2e79b9a"
{
  "type": "contact.list",
  "contacts": [
    { … }
  ]
}

First contact reply

An object containing information on the first users message. For a contact initiated message this will represent the users original message.

created_atinteger(date-time)required
Example: 1663597223
typestringrequired
Example: "conversation"
urlstring or null
Example: "https://developers.intercom.com/"
{
  "created_at": 1663597223,
  "type": "conversation",
  "url": "https://developers.intercom.com/"
}