Home
/
REST API Reference
/
Companies
/
List all companies

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.

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.

SecurityHTTP: bearerAuth
Request
query Parameters
page
integer

The page of results to fetch. Defaults to first page

Example: page=1
per_page
integer

How many results to return per page. Defaults to 15

Example: per_page=15
order
string

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

Example: order=desc
header Parameters
Intercom-Version
string (intercom_version)
Default: Unstable

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "2.11" "Unstable"
Example: Unstable
post
/companies/list
Request samples
Responses
200
Successful
Response Schema: application/json
type
string 
The type of object - list.
 Value: "list"  
object or null (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_count
integer 
The total number of companies.
 
Array of objects (Company)  
An array containing Company Objects.
 
401
Unauthorized
Response samples
application/json
{
"type": "list",
"data": [

],
"pages": {
"type": "pages",
"next": null,
"page": 1,
"per_page": 15,
"total_pages": 1
},
"total_count": 1
}