Intercom API (unofficial showcase)
POST/companies/list

List all companies

Lists companies, ordered by last_request_at and descending by default. Use the pagination parameters to retrieve results in pages; companies without associated users are excluded, and this endpoint can return at most 10,000 companies.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 parameters
pageintegeroptional
The page of results to retrieve. Defaults to the first page when omitted.
per_pageintegeroptional
The number of results to return per page. Defaults to 15 when omitted.
orderstringoptional
Sort order for company results: `asc` or `desc`. Defaults to `desc` when omitted.
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 list of company objects, the total company count, and cursor-based pagination metadata.
typestringoptional
The type of object - `list`.
Allowed:list
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.
dataarray<Company>optional
An array containing Company Objects.
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. Use page and per_page to paginate the results; this endpoint is limited to 10,000 companies, so use the scroll endpoint for larger datasets.