Intercom API (unofficial showcase)

Contacts

Everything about your contacts

Operations

MethodEndpointDescription
GET/companies/{company_id}/contactsList attached contacts
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
GET/contacts/{contact_id}/notesList all notes
POST/contacts/{contact_id}/notesCreate a note
GET/contacts/{contact_id}/segmentsList attached segments for contact
GET/contacts/{contact_id}/subscriptionsList subscriptions for a contact
POST/contacts/{contact_id}/subscriptionsAdd subscription to a contact
DELETE/contacts/{contact_id}/subscriptions/{subscription_id}Remove subscription from a contact
GET/contacts/{contact_id}/tagsList tags attached to a contact
POST/contacts/{contact_id}/tagsAdd tag to a contact
DELETE/contacts/{contact_id}/tags/{tag_id}Remove tag from a contact
GET/contacts/deletedList deleted contacts
GET/contacts/{contact_id}Get a contact
PUT/contacts/{contact_id}Update a contact
DELETE/contacts/{contact_id}Delete a contact
POST/contacts/mergeMerge a lead and a user
POST/contacts/merge/previewPreview a contact merge
POST/contacts/searchSearch contacts
GET/contacts/activitiesList all contact activities
GET/contactsList all contacts
POST/contactsCreate contact
GET/contacts/find_by_external_id/{external_id}Get a contact by External ID
POST/contacts/{contact_id}/archiveArchive contact
POST/contacts/{contact_id}/unarchiveUnarchive contact
GET/contacts/{id}/bannersList banners for a contact
POST/contacts/{id}/banners/{view_id}/dismissDismiss a banner for a contact
POST/contacts/{contact_id}/blockBlock contact
GET/contacts/{id}/merge_historyGet contact merge history
POST/contacts/bulkBulk create contacts
PUT/contacts/bulkBulk update contacts
POST/contacts/bulk/deleteBulk delete contacts
GET/contacts/bulk/{id}Get a bulk update job

Example

List attached contacts, 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.listAttachedContacts({
  companyId: "company-1",
});
console.log(result);
Nine more languages

The same call exists in every SDK. See SDKs for the other nine.