List Companies For A Contact

List attached companies for contact

GET/contacts/{contact_id}/companies

Use it in a workflow

Add a step and choose the Intercom connector.
Pick the List Companies For A Contact action (under Contacts).
Fill in the fields below, then reference the result from later steps as {{listCompaniesForAContact.response.data}}.

Request

Path parameters

contact_idstringrequired

The unique identifier for the contact which is given by Intercom

Headers

Intercom-Versionstring

Intercom API version.</br>By default, it's equal to the version set in the app package.

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Response

Returns 200 with an object. Read it in later steps with {{listCompaniesForAContact.response.data.<field>}}.

typestring

The type of object

One oflist

companiesarray<object>

An array containing Company Objects

typestring

Value is `company`

One ofcompany

idstring

The Intercom defined id representing the company.

namestring

The name of the company.

app_idstring

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

planobject3 fields

company_idstring

The company id you have defined for the company.

remote_created_atinteger

The time the company was created by you.

created_atinteger

The time the company was added in Intercom.

updated_atinteger

The last time the company was updated.

last_request_atinteger

The time the company last recorded making a request.

sizeinteger

The number of employees in the company.

websitestring

The URL for the company website.

industrystring

The industry that the company operates in.

monthly_spendinteger

How much revenue the company generates for your business.

session_countinteger

How many sessions the company has recorded.

user_countinteger

The number of users in the company.

custom_attributesobject

The custom attributes you have set on the company.

tagsobject2 fields

The list of tags associated with the company

segmentsobject2 fields

The list of segments associated with the company

notesobject2 fields

The list of notes associated with the company

total_countinteger

The total number of companies associated to this contact

pagesobject

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.

typestring

One ofpages

pageinteger

nextstring (uri)

A link to the next page of results. A response that does not contain a next link does not have further data to fetch.

per_pageinteger

total_pagesinteger

json

{
  "type": "list",
  "companies": [
    {
      "type": "company",
      "id": "531ee472cce572a6ec000006",
      "name": "Blue Sun",
      "app_id": "ecahpwf5",
      "plan": {
        "type": "plan",
        "id": "269315",
        "name": "Pro"
      },
      "company_id": "6",
      "remote_created_at": 1663597223,
      "created_at": 1663597223,
      "updated_at": 1663597223,
      "last_request_at": 1663597223,
      "size": 100,
      "website": "https://www.intercom.com"
    }
  ],
  "total_count": 100,
  "pages": {
    "type": "pages",
    "page": 1,
    "next": "string",
    "per_page": 50,
    "total_pages": 1
  }
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.

Was this page helpful?