51 things your agent can do in Intercom

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…

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. t…

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…

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.

List attached segments for contact

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

List conversations

Lists conversations from intercom with filtering and pagination support

List subscriptions for a contact

You can fetch a list of subscription types that are attached to a contact. these can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. this w…

List tags attached to a contact

You can fetch a list of all tags that are attached to a specific contact.

Retrieve an admin

You can retrieve the details of a single admin.

Retrieve an article

You can fetch the details of a single article by making a get request to `https://api.intercom.io/articles/<id>`.

Retrieve a collection

You can fetch the details of a single collection by making a get request to `https://api.intercom.io/help center/collections/<id>`.

Retrieve a company by id

You can fetch a single company.

Retrieve a help center

You can fetch the details of a single help center by making a get request to `https://api.intercom.io/help center/help center/<id>`.

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 comp…

Search conversations

Searches for conversations using query string with support for filtering and sorting

Search for articles

You can search for articles by making a get request to `https://api.intercom.io/articles/search`.

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 ty…

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.

Create an article

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

Create a collection

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

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 v…

Delete an article

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

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.

Delete a contact

You can delete a single contact.

Remove subscription from a contact

You can remove a specific subscription from a contact. this will return a subscription type model for the subscription type that was removed from the contact.

Remove tag from a contact

You can remove tag from a specific contact. this will return a tag object for the tag that was removed from the contact.

Set an admin to away

You can set an admin as away for the inbox.

Update an article

You can update the details of a single article by making a put request to `https://api.intercom.io/articles/<id>`.

Update a collection

You can update the details of a single collection by making a put request to `https://api.intercom.io/collections/<id>`.

Update a company

You can update a single company using the intercom provisioned `id`. {% admonition type="attention" name="using `company id`" %} when updating a company it is not possible to update `company id`. thi…

Update a contact

You can update an existing contact (ie. user or lead).

Reply to conversation

Sends a reply to an existing conversation in intercom

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

Detach a contact from a company

You can detach a company from a single contact.

Identify an admin

You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). > 🚧 single sign on > > if you are building a custom "log in with intercom" flow…

Merge a lead and a user

You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.

Reopen conversation

Reopens a closed conversation in intercom

Scroll over all companies

The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. the scroll api provides an efficient mechanism for i…