Home
/
REST API Reference
/
Models
/
Contact Reference

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

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

Models

Contact notes

An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.

dataArray of objects(Addressable List)

This object represents the notes attached to a contact.

urlstring(uri)

Url to get more company resources for this contact

Example: "/contacts/5ba682d23d7cf92bef87bfd4/notes"
total_countinteger

Int representing the total number of companyies attached to this contact

Example: 100
has_moreboolean

Whether there's more Addressable Objects to be viewed. If true, use the url to view all

Example: true
{
  "data": [
    { … }
  ],
  "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes",
  "total_count": 100,
  "has_more": true
}

Contact Reference

reference to 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"
{
  "type": "contact",
  "id": "5ba682d23d7cf92bef87bfd4",
  "external_id": "f3b87a2e09d514c6c2e79b9a"
}

Contact Reply Base Object

message_typestringrequired
Value"comment"
typestringrequired
Value"user"
bodystringrequired

The text body of the comment.

attachment_urlsArray of strings(uri)(Attachment URLs)<= 10 items

A list of image URLs that will be added as attachments. You can include up to 10 URLs.

{
  "message_type": "comment",
  "type": "user",
  "body": "string",
  "attachment_urls": [
    "http://example.com"
  ]
}