Skip to content
Home/
REST API Reference
/
/
Company Scroll

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.

typestringrequired

The type of object - list

Value:"list"
Example:"list"
dataArray of objects(Company)required
pagesobject(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_countinteger or nullrequired

The total number of companies

Example:100
scroll_paramstring

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

Example:"25b649f7-4d33-4ef6-88f5-60e5b8244309"
{
  "type": "list",
  "data": [
    { … }
  ],
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  },
  "total_count": 100,
  "scroll_param": "25b649f7-4d33-4ef6-88f5-60e5b8244309"
}