REST API Reference

Company Attached 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

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

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

Collections

This will return a list of Collections for the App.

typestringrequired

The type of the object - list.

Value"list"

Example: "list"

pagesobject(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.

total_countintegerrequired

A count of the total number of collections.

Example: 1

dataArray of objects(Collection)required

An array of collection objects

data[].idstringrequired

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

Example: "6871119"

data[].workspace_idstringrequired

The id of the workspace which the collection belongs to.

Example: "hfi1bx4l"

data[].namestringrequired

The name of the collection. For multilingual collections, this will be the name of the default language's content.

Example: "Default language name"

data[].descriptionstring or null

The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.

Example: "Default language description"

data[].created_atinteger(date-time)required

The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.

Example: 1672928359

data[].updated_atinteger(date-time)

The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.

Example: 1672928610

data[].urlstring or null

The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.

Example: "http://intercom.test/help/collection/name"

data[].iconstring or null

The icon of the collection.

Example: "book-bookmark"

data[].orderintegerrequired

The order of the section in relation to others sections within a collection. Values go from 0 upwards. 0 is the default if there's no order.

Example: "1"

data[].default_localestringrequired

The default locale of the help center. This field is only returned for multilingual help centers.

Example: "en"

data[].translated_contentobject(Group Translated Content)

The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.

data[].parent_idstring or null

The id of the parent collection. If null then it is the first level collection.

Example: "6871118"

data[].help_center_idinteger or null

The id of the help center the collection is in.

Example: "123"

{
  "type": "list",
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  },
  "total_count": 1,
  "data": [
    { … }
  ]
}

Company Attached Contacts

A list of Contact Objects

typestringrequired

The type of object - list

Value"list"

Example: "list"

dataArray of objects(Contact)required

An array containing Contact Objects

data[].typestring

The type of object.

Example: "contact"

data[].idstringrequired

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

Example: "5ba682d23d7cf92bef87bfd4"

data[].external_idstring or nullrequired

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

Example: "f3b87a2e09d514c6c2e79b9a"

data[].workspace_idstringrequired

The id of the workspace which the contact belongs to.

Example: "ecahpwf5"

data[].rolestringrequired

The role of the contact.

Example: "user"

data[].emailstringrequired

The contact's email.

Example: "joe@example.com"

data[].email_domainstring

The contact's email domain.

Example: "example.com"

data[].phonestring or nullrequired

The contacts phone.

Example: "+1123456789"

data[].formatted_phonestring or null

The contacts phone number normalized to the E164 format

Example: "+1123456789"

data[].namestring or nullrequired

The contacts name.

Example: "John Doe"

data[].owner_idinteger or nullrequired

The id of an admin that has been assigned account ownership of the contact.

Example: 123

data[].has_hard_bouncedbooleanrequired

Whether the contact has had an email sent to them hard bounce.

Example: true

data[].marked_email_as_spambooleanrequired

Whether the contact has marked an email sent to them as spam.

Example: true

data[].unsubscribed_from_emailsbooleanrequired

Whether the contact is unsubscribed from emails.

Example: true

data[].created_atinteger(date-time)required

(UNIX timestamp) The time when the contact was created.

Example: 1571672154

data[].updated_atinteger(date-time)required

(UNIX timestamp) The time when the contact was last updated.

Example: 1571672154

data[].signed_up_atinteger or null(date-time)required

(UNIX timestamp) The time specified for when a contact signed up.

Example: 1571672154

data[].last_seen_atinteger or null(date-time)required

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

Example: 1571672154

data[].last_replied_atinteger or null(date-time)required

(UNIX timestamp) The time when the contact last messaged in.

Example: 1571672154

data[].last_contacted_atinteger or null(date-time)required

(UNIX timestamp) The time when the contact was last messaged.

Example: 1571672154

data[].last_email_opened_atinteger or null(date-time)required

(UNIX timestamp) The time when the contact last opened an email.

Example: 1571672154

data[].last_email_clicked_atinteger or null(date-time)required

(UNIX timestamp) The time when the contact last clicked a link in an email.

Example: 1571672154

data[].language_overridestring or nullrequired

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

Example: "en"

data[].browserstring or nullrequired

The name of the browser which the contact is using.

Example: "Chrome"

data[].browser_versionstring or nullrequired

The version of the browser which the contact is using.

Example: "80.0.3987.132"

data[].browser_languagestring or nullrequired

The language set by the browser which the contact is using.

Example: "en-US"

data[].osstring or nullrequired

The operating system which the contact is using.

Example: "Mac OS X"

data[].android_app_namestring or null

The name of the Android app which the contact is using.

Example: "Intercom"

data[].android_app_versionstring or null

The version of the Android app which the contact is using.

Example: "5.0.0"

data[].android_devicestring or null

The Android device which the contact is using.

Example: "Pixel 3"

data[].android_os_versionstring or null

The version of the Android OS which the contact is using.

Example: "10"

data[].android_sdk_versionstring or null

The version of the Android SDK which the contact is using.

Example: "28"

data[].android_last_seen_atinteger or null(date-time)

(UNIX timestamp) The time when the contact was last seen on an Android device.

Example: 1571672154

data[].ios_app_namestring or null

The name of the iOS app which the contact is using.

Example: "Intercom"

data[].ios_app_versionstring or null

The version of the iOS app which the contact is using.

Example: "5.0.0"

data[].ios_devicestring or null

The iOS device which the contact is using.

Example: "iPhone 11"

data[].ios_os_versionstring or null

The version of iOS which the contact is using.

Example: "13.3.1"

data[].ios_sdk_versionstring or null

The version of the iOS SDK which the contact is using.

Example: "13.3.1"

data[].ios_last_seen_atinteger or null(date-time)

(UNIX timestamp) The last time the contact used the iOS app.

Example: 1571672154

data[].custom_attributesobject

The custom attributes which are set for the contact.

data[].avatarobject or nullrequired

data[].avatar.typestring

The type of object

Example: "avatar"

data[].avatar.image_urlstring or null(uri)

An image URL containing the avatar of a contact.

Example: "https://example.org/128Wash.jpg"

data[].tagsobject(Contact Tags)

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

data[].notesobject(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.

data[].companiesobject(Contact companies)

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

data[].locationobject(Contact Location)required

An object containing location metadata about a Intercom contact.

data[].location.typestringrequired

Always location

Value"location"

Example: "location"

data[].location.countrystring or null

The country that the contact is located in

Example: "Ireland"

data[].location.regionstring or null

The overal region that the contact is located in

Example: "Dublin"

data[].location.citystring or null

The city that the contact is located in

Example: "Dublin"

data[].social_profilesobject(Social Profile)required

An object containing social profiles that a contact has.

data[].social_profiles.dataArray of objects(Social Profile)required

A list of social profiles objects associated with the contact.

data[].social_profiles.data[].typestringrequired

value is "social_profile"

Example: "social_profile"

data[].social_profiles.data[].namestringrequired

The name of the Social media profile

Example: "Facebook"

data[].social_profiles.data[].urlstring(uri)required

The name of the Social media profile

Example: "http://twitter.com/th1sland"

total_countintegerrequired

The total number of contacts

Example: 100

pagesobject(Cursor based pages)

{
  "type": "list",
  "data": [
    { … }
  ],
  "total_count": 100,
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  }
}

Company Attached Segments

A list of Segment Objects

typestringrequired

The type of object - list

Value"list"

Example: "list"

dataArray of objects(Segment)required

An array containing Segment Objects

data[].typestringrequired

The type of object.

Value"segment"

Example: "segment"

data[].idstringrequired

The unique identifier representing the segment.

Example: "56203d253cba154d39010062"

data[].namestringrequired

The name of the segment.

Example: "Active"

data[].created_atintegerrequired

The time the segment was created.

Example: 1394621988

data[].updated_atinteger

The time the segment was updated.

Example: 1394622004

data[].person_typestringrequired

Type of the contact: contact (lead) or user.

Enum"contact""user"

Example: "contact"

data[].countinteger or null

The number of items in the user segment. It's returned when include_count=true is included in the request.

Example: 3

{
  "type": "list",
  "data": [
    { … }
  ]
}