Intercom integration

Get a contact

You can fetch the details of a single contact.

Get conversation

Retrieves a specific conversation by id with all messages and details

List all activity logs

You can get a log of activities by all admins in an app.

List all admins

You can fetch a list of admins for a given workspace.

List all articles

You can fetch a list of all articles by making a get request to `https://api.intercom.io/articles`. > 📘 how are the articles sorted and ordered? > > articles will be returned in descending order on the `updated at` attribute. this means if you need to iterate through results then we'll show the most recently updated articles first.

List all collections

You can fetch a list of all collections by making a get request to `https://api.intercom.io/help center/collections`. collections will be returned in descending order on the `updated at` attribute. this means if you need to iterate through results then we'll show the most recently updated collections first.

List all companies

You can list companies. the company list is sorted by the `last request at` field and by default is ordered descending, most recently requested first. note that the api does not include companies who have no associated users in list responses. when using the companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 companies that can be returned. if you need to list or iterate on more than 10,000 companies, please use the [scroll api](https://developers.intercom.com/reference#iterating-over-all-companies). {% admonition type="warning" name="pagination" %} you can use pagination to limit the number of results returned. the default is `20` results per page. see the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting after` param. {% /admonition %}

List all help centers

You can list all help centers by making a get request to `https://api.intercom.io/help center/help centers`.

List all notes

You can fetch a list of notes that are associated to a contact.

List attached companies for contact

You can fetch a list of companies that are associated to a contact.

List attached contacts

You can fetch a list of all contacts that belong to a company.

List attached segments for companies

You can fetch a list of all segments that belong to a company.

Add subscription to a contact

You can add a specific subscription to a contact. in intercom, we have two different subscription types based on user consent - opt-out and opt-in: 1.attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. 2.attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. this will return a subscription type model for the subscription type that was added to the contact.

Add tag to a contact

You can tag a specific contact. this will return a tag object for the tag that was added to the contact.

Assign conversation

Assigns a conversation to a specific admin or team in intercom

Attach a contact to a company

You can attach a company to a single contact.

Close conversation

Closes a conversation in intercom, marking it as resolved

Create a collection

You can create a new collection by making a post request to `https://api.intercom.io/help center/collections.`

Create an article

You can create a new article by making a post request to `https://api.intercom.io/articles`.

Create a note

You can add a note to a single contact.

Create conversation

Creates a new conversation in intercom

Create or update a company

You can create or update a company. companies will be only visible in intercom when there is at least one associated user. companies are looked up via `company id` in a `post` request, if not found via `company id`, the new company will be created, if found, that company will be updated. {% admonition type="attention" name="using `company id`" %} you can set a unique `company id` value when creating a company. however, it is not possible to update `company id`. be sure to set a unique value once upon creation of the company. {% /admonition %}

Delete a collection

You can delete a single collection by making a delete request to `https://api.intercom.io/collections/<id>`.

Delete a company

You can delete a single company.