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.
{% 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 for more details on how to use the starting_after param.
{% /admonition %}
Servers
- https://api.intercom.io
- https://api.eu.intercom.io
- https://api.au.intercom.io
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Intercom-Version |
String | No |
Possible values:
Default value: "2.12" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
The page of results to fetch. Defaults to first page |
order |
String | No |
|
per_page |
Integer | No |
How many results to return per page. Defaults to 15 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.