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.
Object Models
Company
| Field | Type | Description |
|---|---|---|
| type | string | Value is company |
| id | string | The Intercom defined id representing the company. |
| name | string | The name of the company. |
| app_id | string | The Intercom defined code of the workspace the company is associated to. |
| plan | object | |
| company_id | string | The company id you have defined for the company. |
| remote_created_at | integer | The time the company was created by you. |
| created_at | integer | The time the company was added in Intercom. |
| updated_at | integer | The last time the company was updated. |
| last_request_at | integer | The time the company last recorded making a request. |
| size | integer | The number of employees in the company. |
| website | string | The URL for the company website. |
| industry | string | The industry that the company operates in. |
| monthly_spend | integer | How much revenue the company generates for your business. |
| session_count | integer | How many sessions the company has recorded. |
| user_count | integer | The number of users in the company. |
| custom_attributes | object | The custom attributes you have set on the company. |
| tags | object | The list of tags associated with the company |
| segments | object | The list of segments associated with the company |