result.data | object | Yes | — | A list of Company Objects |
result.data.type | "list" | No | — | The type of object Allowed: list. |
result.data.companies | array | No | — | An array containing Company Objects |
result.data.companies[].type | "company" | No | — | Value is company Allowed: company. |
result.data.companies[].id | string | No | — | The Intercom defined id representing the company. |
result.data.companies[].name | string | No | — | The name of the company. |
result.data.companies[].app_id | string | No | — | The Intercom defined code of the workspace the company is associated to. |
result.data.companies[].plan | object | No | — | — |
result.data.companies[].plan.type | string | No | — | Value is always “plan” |
result.data.companies[].plan.id | string | No | — | The id of the plan |
result.data.companies[].plan.name | string | No | — | The name of the plan |
result.data.companies[].company_id | string | No | — | The company id you have defined for the company. |
result.data.companies[].remote_created_at | integer | No | — | The time the company was created by you. |
result.data.companies[].created_at | integer | No | — | The time the company was added in Intercom. |
result.data.companies[].updated_at | integer | No | — | The last time the company was updated. |
result.data.companies[].last_request_at | integer | No | — | The time the company last recorded making a request. |
result.data.companies[].size | integer | No | — | The number of employees in the company. |
result.data.companies[].website | string | No | — | The URL for the company website. |
result.data.companies[].industry | string | No | — | The industry that the company operates in. |
result.data.companies[].monthly_spend | integer | No | — | How much revenue the company generates for your business. |
result.data.companies[].session_count | integer | No | — | How many sessions the company has recorded. |
result.data.companies[].user_count | integer | No | — | The number of users in the company. |
result.data.companies[].custom_attributes | record | No | — | The custom attributes you have set on the company. |
result.data.companies[].tags | object | No | — | The list of tags associated with the company |
result.data.companies[].tags.type | "tag.list" | No | — | The type of the object Allowed: tag.list. |
result.data.companies[].tags.tags | array | No | — | — |
result.data.companies[].tags.tags[].type | string | No | — | value is “tag” |
result.data.companies[].tags.tags[].id | string | No | — | The id of the tag |
result.data.companies[].tags.tags[].name | string | No | — | The name of the tag |
result.data.companies[].segments | object | No | — | The list of segments associated with the company |
result.data.companies[].segments.type | "segment.list" | No | — | The type of the object Allowed: segment.list. |
result.data.companies[].segments.segments | array | No | — | — |
result.data.companies[].segments.segments[].type | "segment" | No | — | The type of object. Allowed: segment. |
result.data.companies[].segments.segments[].id | string | No | — | The unique identifier representing the segment. |
result.data.companies[].segments.segments[].name | string | No | — | The name of the segment. |
result.data.companies[].segments.segments[].created_at | integer | No | — | The time the segment was created. |
result.data.companies[].segments.segments[].updated_at | integer | No | — | The time the segment was updated. |
result.data.companies[].segments.segments[].person_type | "contact" | "user" | No | — | Type of the contact: contact (lead) or user. Allowed: contact, user. |
result.data.companies[].segments.segments[].count | integer | null | No | — | The number of items in the user segment. It’s returned when include_count=true is included in the request. |
result.data.total_count | integer | No | — | The total number of companies associated to this contact |
result.data.pages | object | No | — | 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. |
result.data.pages.type | "pages" | No | — | Allowed: pages. |
result.data.pages.page | integer | No | — | — |
result.data.pages.next | string | null | No | — | A link to the next page of results. A response that does not contain a next link does not have further data to fetch. Format: uri. |
result.data.pages.per_page | integer | No | — | — |
result.data.pages.total_pages | integer | No | — | — |
result.meta | object | No | — | Additional response metadata (status, paging). |