Intercom API (unofficial showcase)
GET/companies

List or retrieve companies

Lists companies, or retrieves a single company when you filter by company_id or name. Use tag_id or segment_id to filter the results, and use page and per_page to paginate the results.

7 parameters
namestringoptional
Filters companies by company name.
company_idstringoptional
Filters companies by the company ID you defined.
tag_idstringoptional
Filters companies by the ID of an attached tag.
segment_idstringoptional
Filters companies by the ID of an attached segment.
pageintegeroptional
Page of results to retrieve. Defaults to the first page when omitted.
per_pageintegeroptional
Number of results per page. Defaults to 15 when omitted.
Intercom-Versionstringoptional
Selects the API version. Defaults to `2.17` when omitted; supported versions include 1.0 through 1.4 and 2.0 through 2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns a list of company objects with pagination details and the total company count.
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
404Returned when a company matching the supplied `company_id` or `name` is not found.

One documented failure

  • company_not_found

    Company Not Found

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. A 404 is returned when a company selected by company_id or name cannot be found.