Contact companies

Contact Attached Companies

A list of Company Objects

typestringrequired

The type of object

Value"list"

Example: "list"

companiesArray of objects(Company)required

An array containing Company Objects

companies[].typestring

Value is company

Value"company"

Example: "company"

companies[].idstringrequired

The Intercom defined id representing the company.

Example: "531ee472cce572a6ec000006"

companies[].namestringrequired

The name of the company.

Example: "Blue Sun"

companies[].app_idstringrequired

The Intercom defined code of the workspace the company is associated to.

Example: "ecahpwf5"

companies[].planobject

companies[].company_idstringrequired

The company id you have defined for the company.

Example: "6"

companies[].remote_created_atintegerrequired

The time the company was created by you.

Example: 1663597223

companies[].created_atintegerrequired

The time the company was added in Intercom.

Example: 1663597223

companies[].updated_atintegerrequired

The last time the company was updated.

Example: 1663597223

companies[].last_request_atintegerrequired

The time the company last recorded making a request.

Example: 1663597223

companies[].sizeintegerrequired

The number of employees in the company.

Example: 100

companies[].websitestringrequired

The URL for the company website.

Example: "https://www.intercom.com"

companies[].industrystringrequired

The industry that the company operates in.

Example: "Software"

companies[].monthly_spendintegerrequired

How much revenue the company generates for your business.

Example: 100

companies[].session_countintegerrequired

How many sessions the company has recorded.

Example: 100

companies[].user_countintegerrequired

The number of users in the company.

Example: 100

companies[].custom_attributesobject

The custom attributes you have set on the company.

Example: {"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}

companies[].tagsobject

The list of tags associated with the company

companies[].segmentsobject

The list of segments associated with the company

total_countintegerrequired

The total number of companies associated to this contact

Example: 100

pagesobject(Pagination Object)

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

{
  "type": "list",
  "companies": [
    { … }
  ],
  "total_count": 100,
  "pages": {
    "type": "pages",
    "page": 1,
    "next": "http://example.com",
    "per_page": 50,
    "total_pages": 1
  }
}

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.

dataArray of objects(Company Data)

An array of company data objects attached to the contact.

urlstring(uri)required

Url to get more company resources for this contact

Example: "/contacts/5ba682d23d7cf92bef87bfd4/companies"

total_countintegerrequired

Int representing the total number of companyies attached to this contact

Example: 100

has_morebooleanrequired

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

Example: true

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

Company Data

An object containing data about the companies that a contact is associated with.

idstring

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

Example: "5ba682d23d7cf92bef87bfd4"

typestring

The type of the object

Value"company"

Example: "company"

urlstring(uri)

The relative URL of the company.

Example: "/companies/5ba682d23d7cf92bef87bfd4"

{
  "id": "5ba682d23d7cf92bef87bfd4",
  "type": "company",
  "url": "/companies/5ba682d23d7cf92bef87bfd4"
}

Intercom API (2.11)

Admins

Articles

Companies

Contacts

Conversations

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models

Contact Attached Companies

Contact companies

Company Data