$ curl https://api.intercom.io/companies \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json'
HTTP/1.1 200 OK
{
"type": "company.list",
"total_count": 105,
"companies": [
{
"type": "company",
"id": "530370b477ad7120001d",
...
},
...
],
"pages": {
"next": "https://api.intercom.io/companies?per_page=50&page=2",
"page": 1,
"per_page": 50,
"total_pages": 3
}
}
# NB: Full company objects are returned
intercom.companies.all.each { ... }
<?php
$companies= $intercom->companies->getCompanies([]);
foreach ($companies->companies as $company) {
print_r($company->company_id);
echo "\n";
}
?>
CompanyCollection companies = Company.list();
// get first page
List<Company> items = companies.getPageItems();
// or iterate over pages
while (companies.hasNext()) {
System.out.println(companies.next().getName());
}
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.
Request Parameters
You can optionally request the result page size and which page to fetch as follows -
Parameter | Required | Description |
---|---|---|
page | no | what page of results to fetch defaults to first page. |
per_page | no | how many results per page defaults to 15. |
order | no |
|
Request Query Parameters
Parameter | Required | Description |
---|---|---|
tag_id | one of | The |
segment_id | one of | The |
Response
This will return a paginated list of Company Objects
Attribute | Type | Description |
---|---|---|
type | String | The type of object - |
data | Array | An array containing Company Objects. |
total_count | Integer | The total number of companies. |
pages | The information needed to paginate through companies |
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.