Company Scroll

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.

type	string The type of object - `list` Value: "list"
	Array of objects (Company)
	object or null (Cursor based pages) Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
total_count	integer or null The total number of companies
scroll_param	string The scroll parameter to use in the next request to fetch the next page of results.

{ "type": "list", "data": [ { "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": [ [ { "type": "tag", "id": "123456", "name": "Test tag", "applied_at": 1663597223, "applied_by": { "type": null, "id": null } } ] ] }, "segments": { "type": "segment.list", "segments": [ { "type": "segment", "id": "56203d253cba154d39010062", "name": "Active", "created_at": 1394621988, "updated_at": 1394622004, "person_type": "contact", "count": 3 } ] } } ], "pages": { "type": "pages", "page": 1, "next": { "per_page": 2, "starting_after": "your-cursor-from-response" }, "per_page": 2, "total_pages": 13 }, "total_count": 100, "scroll_param": "25b649f7-4d33-4ef6-88f5-60e5b8244309" }