younifyd
Menu

Scroll Over All Companies

Scroll over all companies

GET/companies/scroll

Use it in a workflow

  1. Add a step and choose the Intercom connector.
  2. Pick the Scroll Over All Companies action (under Companies).
  3. Fill in the fields below, then reference the result from later steps as {{scrollOverAllCompanies.response.data}}.

Request

Query parameters

scroll_paramstring

Headers

Intercom-Versionstring

Intercom API version.</br>By default, it's equal to the version set in the app package.

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Response

Returns 200 with an object. Read it in later steps with {{scrollOverAllCompanies.response.data.<field>}}.

typestring

The type of object - `list`

One oflist

dataarray<object>
typestring

Value is `company`

One ofcompany

idstring

The Intercom defined id representing the company.

namestring

The name of the company.

app_idstring

The Intercom defined code of the workspace the company is associated to.

planobject3 fields
company_idstring

The company id you have defined for the company.

remote_created_atinteger

The time the company was created by you.

created_atinteger

The time the company was added in Intercom.

updated_atinteger

The last time the company was updated.

last_request_atinteger

The time the company last recorded making a request.

sizeinteger

The number of employees in the company.

websitestring

The URL for the company website.

industrystring

The industry that the company operates in.

monthly_spendinteger

How much revenue the company generates for your business.

session_countinteger

How many sessions the company has recorded.

user_countinteger

The number of users in the company.

custom_attributesobject

The custom attributes you have set on the company.

tagsobject2 fields

The list of tags associated with the company

segmentsobject2 fields

The list of segments associated with the company

notesobject2 fields

The list of notes associated with the company

pagesobject

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.

typestring

the type of object `pages`.

One ofpages

pageinteger

The current page

nextobject2 fields
per_pageinteger

Number of results per page

total_pagesinteger

Total number of pages

total_countinteger

The total number of companies

scroll_paramstring

The scroll parameter to use in the next request to fetch the next page of results.

json
{
  "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"
    }
  ],
  "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"
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.