Contact

Contacts represent your leads and users in Intercom.

typestring

The type of object.

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"

workspace_idstring

The id of the workspace which the contact belongs to.

Example:"ecahpwf5"

rolestring

The role of the contact.

Example:"user"

emailstring

The contact's email.

Example:"joe@example.com"

email_domainstring

The contact's email domain.

Example:"example.com"

phonestring or null

The contacts phone.

Example:"+1123456789"

formatted_phonestring or null

The contacts phone number normalized to the E164 format

Example:"+1123456789"

namestring or null

The contacts name.

Example:"John Doe"

owner_idstring or null

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

Example:"321"

has_hard_bouncedboolean

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

Example:true

marked_email_as_spamboolean

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

Example:true

unsubscribed_from_emailsboolean

Whether the contact is unsubscribed from emails.

Example:true

created_atinteger, (date-time)

(Unix timestamp in seconds) The time when the contact was created.

Example:1571672154

updated_atinteger, (date-time)

(Unix timestamp in seconds) The time when the contact was last updated.

Example:1571672154

signed_up_atinteger or null, (date-time)

(Unix timestamp in seconds) The time specified for when a contact signed up.

Example:1571672154

last_seen_atinteger or null, (date-time)

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

Example:1571672154

last_replied_atinteger or null, (date-time)

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

Example:1571672154

last_contacted_atinteger or null, (date-time)

(Unix timestamp in seconds) The time when the contact was last messaged.

Example:1571672154

last_email_opened_atinteger or null, (date-time)

(Unix timestamp in seconds) The time when the contact last opened an email.

Example:1571672154

last_email_clicked_atinteger or null, (date-time)

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

Example:1571672154

language_overridestring or null

A preferred language setting for the contact, used by Intercom as the language of Fin and the Messenger even if their browser has a different setting. Supports ISO 639-1 two-letter language codes. If an unsupported code is supplied, the field will be set to null.

Example:"en"

browserstring or null

The name of the browser which the contact is using.

Example:"Chrome"

browser_versionstring or null

The version of the browser which the contact is using.

Example:"80.0.3987.132"

browser_languagestring or null

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

Example:"en-US"

osstring or null

The operating system which the contact is using.

Example:"Mac OS X"

android_app_namestring or null

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

Example:"Intercom"

android_app_versionstring or null

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

Example:"5.0.0"

android_devicestring or null

The Android device which the contact is using.

Example:"Pixel 3"

android_os_versionstring or null

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

Example:"10"

android_sdk_versionstring or null

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

Example:"28"

android_last_seen_atinteger or null, (date-time)

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

Example:1571672154

ios_app_namestring or null

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

Example:"Intercom"

ios_app_versionstring or null

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

Example:"5.0.0"

ios_devicestring or null

The iOS device which the contact is using.

Example:"iPhone 11"

ios_os_versionstring or null

The version of iOS which the contact is using.

Example:"13.3.1"

ios_sdk_versionstring or null

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

Example:"13.3.1"

ios_last_seen_atinteger or null, (date-time)

(Unix timestamp in seconds) The last time the contact used the iOS app.

Example:1571672154

custom_attributesobject

The custom attributes which are set for the contact.

avatarobject or null

tagsobject or null(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.

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.

companiesobject(Contact companies)

An object with metadata about companies attached to a contact . Up to 10 will be displayed here. Use the url to get more.

locationobject(Contact Location)

An object containing location meta data about a Intercom contact.

social_profilesobject(Social Profile)

An object containing social profiles that a contact has.

merge_historyArray of objects or null(Merge History Item)

A list of contacts that were merged into this contact. Only included in the response when include_merge_history=true is passed as a query parameter. Only available for contacts with a user role.

{
  "type": "contact",
  "id": "5ba682d23d7cf92bef87bfd4",
  "external_id": "f3b87a2e09d514c6c2e79b9a",
  "workspace_id": "ecahpwf5",
  "role": "user",
  "email": "joe@example.com",
  "email_domain": "example.com",
  "phone": "+1123456789",
  "formatted_phone": "+1123456789",
  "name": "John Doe",
  "owner_id": "321",
  "has_hard_bounced": true,
  "marked_email_as_spam": true,
  "unsubscribed_from_emails": true,
  "created_at": 1571672154,
  "updated_at": 1571672154,
  "signed_up_at": 1571672154,
  "last_seen_at": 1571672154,
  "last_replied_at": 1571672154,
  "last_contacted_at": 1571672154,
  "last_email_opened_at": 1571672154,
  "last_email_clicked_at": 1571672154,
  "language_override": "en",
  "browser": "Chrome",
  "browser_version": "80.0.3987.132",
  "browser_language": "en-US",
  "os": "Mac OS X",
  "android_app_name": "Intercom",
  "android_app_version": "5.0.0",
  "android_device": "Pixel 3",
  "android_os_version": "10",
  "android_sdk_version": "28",
  "android_last_seen_at": 1571672154,
  "ios_app_name": "Intercom",
  "ios_app_version": "5.0.0",
  "ios_device": "iPhone 11",
  "ios_os_version": "13.3.1",
  "ios_sdk_version": "13.3.1",
  "ios_last_seen_at": 1571672154,
  "custom_attributes": {},
  "avatar": {
    "type": "avatar",
    "image_url": "https://example.org/128Wash.jpg"
  },
  "tags": {
    "data": [ … ],
    "url": "/contacts/5ba682d23d7cf92bef87bfd4/tags",
    "total_count": 100,
    "has_more": true
  },
  "notes": {
    "data": [ … ],
    "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes",
    "total_count": 100,
    "has_more": true
  },
  "companies": {
    "data": [ … ],
    "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies",
    "total_count": 100,
    "has_more": true
  },
  "location": {
    "type": "location",
    "country": "Ireland",
    "region": "Dublin",
    "city": "Dublin"
  },
  "social_profiles": {
    "data": [ … ]
  },
  "merge_history": [
    { … }
  ]
}