provider Companies POST /companies/list
@utdk/intercom /companies/list
List all companies
You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first. Note that the API does not include companies who have no associated users in list responses. When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). {% admonition type="warning" name="Pagination" %} You can use pagination to limit the number of results returned. The default is `20` results per page. See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. {% /admonition %}
Intercom-Version header
enum: 1.0, 1.1, 1.2, 1.3…
page query
The page of results to fetch. Defaults to first page
integer
per_page query
How many results to return per page. Defaults to 15
integer
order query
`asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc
string

Try it

Authentication
Configure credentials for Intercom API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

listallcompanies
POST/companies/list
You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first. Note that the API does not include companies who have no associated users in list responses. When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). {% admonition type="warning" name="Pagination" %} You can use pagination to limit the number of results returned. The default is `20` results per page. See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. {% /admonition %}

The page of results to fetch. Defaults to first page

How many results to return per page. Defaults to 15

`asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import intercom from '@utdk/intercom';

await intercom.listallcompanies({
  "Intercom-Version": "2.14"
})