Skip to content
Home/
REST API Reference
/
/
Company

Company

Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.

typestring

Value is company

Value:"company"
Example:"company"
idstringrequired

The Intercom defined id representing the company.

Example:"531ee472cce572a6ec000006"
namestringrequired

The name of the company.

Example:"Blue Sun"
app_idstringrequired

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

Example:"ecahpwf5"
planobject
company_idstringrequired

The company id you have defined for the company.

Example:"6"
remote_created_atintegerrequired

The time the company was created by you.

Example:1663597223
created_atintegerrequired

The time the company was added in Intercom.

Example:1663597223
updated_atintegerrequired

The last time the company was updated.

Example:1663597223
last_request_atintegerrequired

The time the company last recorded making a request.

Example:1663597223
sizeintegerrequired

The number of employees in the company.

Example:100
websitestringrequired

The URL for the company website.

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

The industry that the company operates in.

Example:"Software"
monthly_spendintegerrequired

How much revenue the company generates for your business.

Example:100
session_countintegerrequired

How many sessions the company has recorded.

Example:100
user_countintegerrequired

The number of users in the company.

Example:100
custom_attributesobject

The custom attributes you have set on the company.

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

The list of tags associated with the company

segmentsobject

The list of segments associated with the company

{
  "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",
  "industry": "Software",
  "monthly_spend": 100,
  "session_count": 100,
  "user_count": 100,
  "custom_attributes": {
    "paid_subscriber": true,
    "monthly_spend": 155.5,
    "team_mates": 9
  },
  "tags": {
    "type": "tag.list",
    "tags": [ … ]
  },
  "segments": {
    "type": "segment.list",
    "segments": [ … ]
  }
}