Intercom API (unofficial showcase)
GET/companies/scroll

Scroll through all companies

Lists companies by using a cursor-based scroll to iterate through a large dataset. Omit scroll_param to start a scroll, then pass the returned value on subsequent requests; only one scroll can be open per app at a time, and an unused scroll expires after one minute.

2 parameters
scroll_paramstringoptional
The cursor returned by a previous response to retrieve the next batch of companies. Omit it to start a new scroll.
Intercom-Versionstringoptional
API version to use for the request. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

2 status codes
200Returns a batch of company objects, the total company count, pagination metadata, and a `scroll_param` value to use for the next request.
typestringoptional
The type of object - `list`
Allowed:list
dataarray<Company>optional
pagesobjectoptional
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_countintegeroptional
The total number of companies
scroll_paramstringoptional
The scroll parameter to use in the next request to fetch the next page of results.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. Omit scroll_param to start the scroll, then pass the returned cursor to continue; an unused cursor expires after one minute, and only one scroll can be open per app at a time.