Retrieve companies

Home

REST API Reference

Companies

Retrieve companies

You can fetch a single company by passing in company_id or name.

https://api.intercom.io/companies?name={name}

https://api.intercom.io/companies?company_id={company_id}

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

https://api.intercom.io/companies?tag_id={tag_id}

https://api.intercom.io/companies?segment_id={segment_id}

SecurityHTTP: bearerAuth

Request

query Parameters

name	string The `name` of the company to filter by. Example: name=my company
company_id	string The `company_id` of the company to filter by. Example: company_id=12345
tag_id	string The `tag_id` of the company to filter by. Example: tag_id=678910
segment_id	string The `segment_id` of the company to filter by. Example: segment_id=98765
page	integer The page of results to fetch. Defaults to first page Example: page=1
per_page	integer How many results to display per page. Defaults to 15 Example: per_page=15

header Parameters

Intercom-Version

string (intercom_version)

Default: 2.10

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" "Unstable"

Example: 2.10

get

/companies

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

404

Company Not Found

Response samples
200
401
404
application/json
Successful
{
"type": "list",
"data": [
{
"type": "company",
"company_id": "remote_companies_scroll_2",
"id": "660e72ae6abd01bd27af60d7",
"app_id": "this_is_an_id111_that_should_be_at_least_",
"name": "IntercomQATest1",
"remote_created_at": 1712222894,
"created_at": 1712222894,
"updated_at": 1712222894,
"monthly_spend": 0,
"session_count": 0,
"user_count": 4,
"tags": {
"type": "tag.list",
"tags": [ ]
},
"segments": {
"type": "segment.list",
"segments": [ ]
},
"plan": { },
"custom_attributes": { }
}
],
"pages": {
"type": "pages",
"next": null,
"page": 1,
"per_page": 15,
"total_pages": 1
},
"total_count": 1
}