Companies
Everything about your Companies
Operations
| Method | Endpoint | Description |
|---|---|---|
GET | /companies | Retrieve companies |
POST | /companies | Create or Update a company |
GET | /companies/{company_id} | Retrieve a company by ID |
PUT | /companies/{company_id} | Update a company |
DELETE | /companies/{company_id} | Delete a company |
GET | /companies/{company_id}/contacts | List attached contacts |
GET | /companies/{company_id}/segments | List attached segments for companies |
GET | /companies/{company_id}/notes | List all company notes |
POST | /companies/{company_id}/notes | Create a company note |
POST | /companies/search | Search companies |
POST | /companies/list | List all companies |
GET | /companies/scroll | Scroll over all companies |
GET | /contacts/{contact_id}/companies | List attached companies for contact |
POST | /contacts/{contact_id}/companies | Attach a Contact to a Company |
DELETE | /contacts/{contact_id}/companies/{company_id} | Detach a contact from a company |
Example
Retrieve companies, with the TypeScript SDK:
ts
import { Intercom } from "@octridev/intercom";
const client = new Intercom({
// Optional: replaces the default server and any server an operation declares.
baseUrl: "https://api.intercom.io",
auth: { bearerAuth: process.env.API_TOKEN! },
});
const result = await client.companies.retrieve();
console.log(result);Nine more languages
The same call exists in every SDK. See SDKs for the other nine.