Skip to content
Home/
REST API Reference
/
/
Companies

Companies

This will return a list of companies for the App.

typestringrequired

The type of object - list.

Value:"list"
Example:"list"
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_countintegerrequired

The total number of companies.

Example:100
dataArray of objects(Company)required

An array containing Company Objects.

{
  "type": "list",
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  },
  "total_count": 100,
  "data": [
    { … }
  ]
}