Intercom: Scroll Over All Companies

Go through every company in a large Intercom workspace.

Tool ID: intercom_scroll_over_all_companies

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_scroll_over_all_companies',
  {
    "scroll_param": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_scroll_over_all_companies --input '{
  "scroll_param": "example"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "type": "list",
    "data": [
      {
        "type": "company",
        "id": "id_123",
        "name": "Example"
      }
    ],
    "pages": {
      "type": "pages",
      "page": 123,
      "next": {
        "per_page": 123,
        "starting_after": "cursor_123"
      }
    }
  }
}

Use deepline describe intercom_scroll_over_all_companies --json for the latest machine-readable contract.

Input reference

The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. - Each app can only have 1 scroll open at a time. You’ll get an error message if you try to have more than one open per app. - If the scroll isn’t used for 1 minute, it expires and calls with that scroll param will fail - If the end of the scroll is reached, “companies” will be empty and the scroll parameter will expire You can get the first page of companies by simply sending a GET request to the scroll endpoint. For subsequent requests you will need to use the scroll parameter from the response. Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the See the live schema below for the complete notes.

Name	Type	Required	Default	Details
`payload.scroll_param`	`string`	No	—	—

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	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.
`result.data.type`	`"list"`	No	—	The type of object - `list` Allowed: `list`.
`result.data.data`	`array`	No	—	—
`result.data.data[].type`	`"company"`	No	—	Value is `company` Allowed: `company`.
`result.data.data[].id`	`string`	No	—	The Intercom defined id representing the company.
`result.data.data[].name`	`string`	No	—	The name of the company.
`result.data.data[].app_id`	`string`	No	—	The Intercom defined code of the workspace the company is associated to.
`result.data.data[].plan`	`object`	No	—	—
`result.data.data[].plan.type`	`string`	No	—	Value is always “plan”
`result.data.data[].plan.id`	`string`	No	—	The id of the plan
`result.data.data[].plan.name`	`string`	No	—	The name of the plan
`result.data.data[].company_id`	`string`	No	—	The company id you have defined for the company.
`result.data.data[].remote_created_at`	`integer`	No	—	The time the company was created by you.
`result.data.data[].created_at`	`integer`	No	—	The time the company was added in Intercom.
`result.data.data[].updated_at`	`integer`	No	—	The last time the company was updated.
`result.data.data[].last_request_at`	`integer`	No	—	The time the company last recorded making a request.
`result.data.data[].size`	`integer`	No	—	The number of employees in the company.
`result.data.data[].website`	`string`	No	—	The URL for the company website.
`result.data.data[].industry`	`string`	No	—	The industry that the company operates in.
`result.data.data[].monthly_spend`	`integer`	No	—	How much revenue the company generates for your business.
`result.data.data[].session_count`	`integer`	No	—	How many sessions the company has recorded.
`result.data.data[].user_count`	`integer`	No	—	The number of users in the company.
`result.data.data[].custom_attributes`	`record`	No	—	The custom attributes you have set on the company.
`result.data.data[].tags`	`object`	No	—	The list of tags associated with the company
`result.data.data[].tags.type`	`"tag.list"`	No	—	The type of the object Allowed: `tag.list`.
`result.data.data[].tags.tags`	`array`	No	—	—
`result.data.data[].tags.tags[].type`	`string`	No	—	value is “tag”
`result.data.data[].tags.tags[].id`	`string`	No	—	The id of the tag
`result.data.data[].tags.tags[].name`	`string`	No	—	The name of the tag
`result.data.data[].segments`	`object`	No	—	The list of segments associated with the company
`result.data.data[].segments.type`	`"segment.list"`	No	—	The type of the object Allowed: `segment.list`.
`result.data.data[].segments.segments`	`array`	No	—	—
`result.data.data[].segments.segments[].type`	`"segment"`	No	—	The type of object. Allowed: `segment`.
`result.data.data[].segments.segments[].id`	`string`	No	—	The unique identifier representing the segment.
`result.data.data[].segments.segments[].name`	`string`	No	—	The name of the segment.
`result.data.data[].segments.segments[].created_at`	`integer`	No	—	The time the segment was created.
`result.data.data[].segments.segments[].updated_at`	`integer`	No	—	The time the segment was updated.
`result.data.data[].segments.segments[].person_type`	`"contact" \| "user"`	No	—	Type of the contact: contact (lead) or user. Allowed: `contact`, `user`.
`result.data.data[].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.pages`	`object \| null`	No	—	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.
`result.data.pages.type`	`"pages"`	No	—	the type of object `pages`. Allowed: `pages`.
`result.data.pages.page`	`integer`	No	—	The current page
`result.data.pages.next`	`object \| null`	No	—	—
`result.data.pages.next.per_page`	`integer`	No	—	The number of results to fetch per page.
`result.data.pages.next.starting_after`	`string \| null`	No	—	The cursor to use in the next request to get the next page of results.
`result.data.pages.per_page`	`integer`	No	—	Number of results per page
`result.data.pages.total_pages`	`integer`	No	—	Total number of pages
`result.data.total_count`	`integer \| null`	No	—	The total number of companies
`result.data.scroll_param`	`string`	No	—	The scroll parameter to use in the next request to fetch the next page of results.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation