The company model

Example Company Object

{
  "type": "company",
  "id": "531ee472cce572a6ec000006",
  "name": "Blue Sun",
  "plan": {
    "type": "plan",
    "id": "269315",
    "name": "pro"
  },
  "company_id": "6",
  "remote_created_at": 1394531169,
  "created_at": 1394533506,
  "updated_at": 1396874658,
  "size": 85,
  "website": "http://www.example.com",
  "industry": "Manufacturing",
  "monthly_spend": 49,
  "session_count": 26,
  "user_count": 10,
  "custom_attributes": {
    "paid_subscriber": true,
    "team_mates": 0
  }
}

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.

Companies will not appear within Intercom until users have been added or associated with a company.

Company object

AttributeTypeDescription
typeStringValue is 'company'.
idStringThe Intercom defined id representing the company.
created_atDate (UNIX timestamp)The time the company was added to Intercom.
remote_created_atDate (UNIX timestamp)The time the company was created by you.
updated_atDate (UNIX timestamp)The last time the company was updated.
last_request_atDate (UNIX timestamp)The time the company last recorded making a request.
company_idStringThe company id you have defined for the company.
nameStringThe name of the company.
custom_attributesObjectThe custom attributes you have set on the company.
session_countIntegerHow many sessions the company has recorded.
monthly_spendIntegerHow much revenue the company generates for your business.
user_countIntegerThe number of users in the company.
planObjectThe name of the plan you have associated with the company.
sizeIntegerThe number of employees in the company.
websiteStringThe URL for the company website.
industryStringThe industry that the company operates in.

Plan object

AttributeTypeDescription
typestringWill always be of type 'plan'
idstringThe plan ID
namestringThe name of the plan, note that this is the only field that can be set via the API.