Companies

Everything about your Companies

Operations

MethodEndpointDescription
GET/companiesRetrieve companies
POST/companiesCreate 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}/contactsList attached contacts
GET/companies/{company_id}/segmentsList attached segments for companies
GET/companies/{company_id}/notesList all company notes
POST/companies/{company_id}/notesCreate a company note
POST/companies/searchSearch companies
POST/companies/listList all companies
GET/companies/scrollScroll over all companies
GET/contacts/{contact_id}/companiesList attached companies for contact
POST/contacts/{contact_id}/companiesAttach 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.