Example Contacts Object
{
"type": "contact",
"id": "5ba682d23d7cf92bef87bfd4",
"workspace_id": "ecahpwf5",
"external_id": "25",
"role": "user",
"email": "[email protected]",
"phone": "+1123456789",
"name": "Hoban Washburn",
"avatar": "https://example.org/128Wash.jpg",
"owner_id": 127,
"social_profiles": {
"type": "list",
"data": [
{
"type": "social_profile",
"name": "Twitter",
"url": "http://twitter.com/th1sland"
}
]
},
"has_hard_bounced": false,
"marked_email_as_spam": false,
"unsubscribed_from_emails": false,
"created_at": 1571672154,
"updated_at": 1571672158,
"signed_up_at": 1571069751,
"last_seen_at": 1571069751,
"last_replied_at": 1571672158,
"last_contacted_at": 1571672158,
"last_email_opened_at": 1571673478,
"last_email_clicked_at": 1571676789,
"language_override": null,
"browser": "chrome",
"browser_version": "77.0.3865.90",
"browser_language": "en",
"os": "OS X 10.14.6",
"location": {
"type": "location",
"country": "Ireland",
"region": "Dublin",
"city": "Dublin"
},
"android_app_name": null,
"android_app_version": null,
"android_device": null,
"android_os_version": null,
"android_sdk_version": null,
"android_last_seen_at": null,
"ios_app_name": null,
"ios_app_version": null,
"ios_device": null,
"ios_os_version": null,
"ios_sdk_version": null,
"ios_last_seen_at": null,
"custom_attributes": {
"paid_subscriber": true,
"monthly_spend": 155.5,
"team_mates": 1
},
"tags": {
"type": "list",
"data": [
{
"type": "tag",
"id": "2",
"url": "/tags/2"
},
{
"type": "tag",
"id": "4",
"url": "/tags/4"
},
{
"type": "tag",
"id": "5",
"url": "/tags/5"
}
],
"url": "/contacts/5ba682d23d7cf92bef87bfd4/tags",
"total_count": 3,
"has_more": false
},
"notes": {
"type": "list",
"data": [
{
"type": "note",
"id": "20114858",
"url": "/notes/20114858"
}
],
"url": "/contacts/5ba682d23d7cf92bef87bfd4/notes",
"total_count": 1,
"has_more": false
},
"opted_out_subscription_types": {
"type": "list",
"data": [
{
"id": "1",
"type": "subscription",
"url": "/subscription_types/1"
}
],
"url": "/contacts/5ba682d23d7cf92bef87bfd4/subscriptions",
"total_count": 1,
"has_more": false
},
"opted_in_subscription_types": {
"type": "list",
"data": [
{
"id": "2",
"type": "subscription",
"url": "/subscription_types/2"
}
],
"url": "/contacts/5ba682d23d7cf92bef87bfd4/subscriptions",
"total_count": 1,
"has_more": false
},
"companies": {
"type": "list",
"data": [
{
"type": "company",
"id": "5ba686093d7cf93552a3dc99",
"url": "/companies/5ba686093d7cf93552a3dc99"
},
{
"type": "company",
"id": "5cee64a03d7cf90c51b36f19",
"url": "/companies/5cee64a03d7cf90c51b36f19"
},
{
"type": "company",
"id": "5d7668883d7cf944dbc5c791",
"url": "/companies/5d7668883d7cf944dbc5c791"
}
],
"url": "/contacts/5ba682d23d7cf92bef87bfd4/companies",
"total_count": 3,
"has_more": false
},
"utm_campaign": "my-campaign",
"utm_content": null,
"utm_medium": "social",
"utm_source": null,
"utm_term": null,
"referrer": null
}
Our Contacts API is a central place to gather all information and take actions on your contacts (ie. users and leads), such as fetching, searching, creating, updating, and deleting.
The Contacts Model provides details on these contacts within Intercom, and will specify whether they are a user or lead through the role attribute.
Object Models
Contact
| Field | Type | Description |
|---|---|---|
| type | string | The type of object. |
| id | string | The unique identifier for the contact which is given by Intercom. |
| workspace_id | string | The id of the workspace which the contact belongs to. |
| role | string | The role of the contact. |
| string | The contacts email. | |
| phone | string | The contacts phone. |
| name | string | The contacts name. |
| owner_id | integer | The id of an admin that has been assigned account ownership of the contact. |
| has_hard_bounced | boolean | Whether the contact has had an email sent to them hard bounce. |
| marked_email_as_spam | boolean | Whether the contact has marked an email sent to them as spam. |
| unsubscribed_from_emails | boolean | Whether the contact is unsubscribed from emails. |
| created_at | integer | (UNIX timestamp) The time when the contact was created. |
| updated_at | integer | (UNIX timestamp) The time when the contact was last updated. |
| signed_up_at | integer | (UNIX timestamp) The time specified for when a contact signed up. |
| last_seen_at | integer | (UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually). |
| last_replied_at | integer | (UNIX timestamp) The time when the contact last messaged in. |
| last_contacted_at | integer | (UNIX timestamp) The time when the contact was last messaged. |
| last_email_opened_at | integer | (UNIX timestamp) The time when the contact last opened an email. |
| last_email_clicked_at | integer | (UNIX timestamp) The time when the contact last clicked a link in an email. |
| language_override | string | A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change. |
| browser | string | The name of the browser which the contact is using. |
| browser_version | string | The version of the browser which the contact is using. |
| browser_language | string | The language set by the browser which the contact is using. |
| os | string | The operating system which the contact is using. |
| android_app_name | string | The name of the Android app which the contact is using. |
| android_app_version | string | The version of the Android app which the contact is using. |
| android_device | string | The Android device which the contact is using. |
| android_os_version | string | The version of the Android OS which the contact is using. |
| android_sdk_version | string | The version of the Android SDK which the contact is using. |
| android_last_seen_at | integer | (UNIX timestamp) The time when the contact was last seen on an Android device. |
| ios_app_name | string | The name of the iOS app which the contact is using. |
| ios_app_version | string | The version of the iOS app which the contact is using. |
| ios_device | string | The iOS device which the contact is using. |
| ios_os_version | string | The version of iOS which the contact is using. |
| ios_sdk_version | string | The version of the iOS SDK which the contact is using. |
| ios_last_seen_at | integer | (UNIX timestamp) The last time the contact used the iOS app. |
| custom_attributes | object | The custom attributes which are set for the contact. |
| avatar | object | |
| tags | object | An object containing tags meta data about the tags that a contact has. |
| notes | object | An object containing notes meta data about the notes that a contact has. |
| companies | object | An object containing companies meta data about the companies that a contact has. |
| location | object | An object containing location meta data about a Intercom contact. |
| social_profiles | object | An object containing social profiles that a contact has. |
Contact Tags
| Field | Type | Description |
|---|---|---|
| data | array | This object represents the tags attached to a contact. |
| url | string | url to get more tag resources for this contact |
| total_count | integer | Int representing the total number of tags attached to this contact |
| has_more | boolean | Whether there's more Addressable Objects to be viewed. If true, use the url to view all |
Contact Notes
| Field | Type | Description |
|---|---|---|
| data | array | This object represents the notes attached to a contact. |
| url | string | Url to get more company resources for this contact |
| total_count | integer | Int representing the total number of companyies attached to this contact |
| has_more | boolean | Whether there's more Addressable Objects to be viewed. If true, use the url to view all |
Contact Companies
| Field | Type | Description |
|---|---|---|
| url | string | Url to get more company resources for this contact |
| total_count | integer | Int representing the total number of companyies attached to this contact |
| has_more | boolean | Whether there's more Addressable Objects to be viewed. If true, use the url to view all |
Contact Location
| Field | Type | Description |
|---|---|---|
| type | string | Always location |
| country | string | The country that the contact is located in |
| region | string | The overal region that the contact is located in |
| city | string | The city that the contact is located in |
Contact Social Profiles
| Field | Type | Description |
|---|---|---|
| data | array | A list of social profiles objects associated with the contact. |