younifyd
Menu

Retrieve A Company By Id

Retrieve a company by ID

GET/companies/{company_id}

Use it in a workflow

  1. Add a step and choose the Intercom connector.
  2. Pick the Retrieve A Company By Id action (under Companies).
  3. Fill in the fields below, then reference the result from later steps as {{retrieveACompanyById.response.data}}.

Request

Path parameters

company_idstringrequired

The unique identifier for the company 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 {{retrieveACompanyById.response.data.<field>}}.

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.

planobject
typestring

Value is always "plan"

idstring

The id of the plan

namestring

The name of the plan

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.

tagsobject

The list of tags associated with the company

typestring

The type of the object

One oftag.list

tagsarray<object>3 fields
segmentsobject

The list of segments associated with the company

typestring

The type of the object

One ofsegment.list

segmentsarray<object>7 fields
notesobject

The list of notes associated with the company

typestring

The type of the object

One ofnote.list

notesarray<object>6 fields
json
{
  "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"
}

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