provider Companies GET
/companies @utdk/intercom
/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}`
- Intercom-Version header
- enum: 1.0, 1.1, 1.2, 1.3…
- name query
- The `name` of the company to filter by.
- string
- company_id query
- The `company_id` of the company to filter by.
- string
- tag_id query
- The `tag_id` of the company to filter by.
- string
- segment_id query
- The `segment_id` of the company to filter by.
- string
- page query
- The page of results to fetch. Defaults to first page
- integer
- per_page query
- How many results to display per page. Defaults to 15
- integer
Try it
Authentication
Configure credentials for Intercom API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import intercom from '@utdk/intercom';
await intercom.retrievecompany({
"Intercom-Version": "2.14"
})