> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # Intercom > Intercom provides live chat, messaging, and customer engagement tools, enabling businesses to drive conversions, handle support, and personalize communication at scale Intercom provides live chat, messaging, and customer engagement tools, enabling businesses to drive conversions, handle support, and personalize communication at scale `intercom` ยท **133 tools** ยท no triggers ## Connect it ```bash theme={"theme":"github-dark"} run auth intercom run auth intercom --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run intercom # common commands run intercom --all # every command ``` ```ts theme={"theme":"github-dark"} import { intercom } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `archive-contact` | Tool to archive a single contact in Intercom. Use when you need to archive a contact by their ID. | | `assign-conversation` | Assigns a conversation to a specific admin or team in Intercom. | | `attach-contact-to-company` | Tool to attach a contact to a company in Intercom. Use when you need to associate a contact with a company. | | `attach-contact-to-conversation` | Tool to attach a contact participant to a conversation on behalf of admin or contact. | | `block-contact` | Tool to block a single contact in Intercom. Use when you need to block a contact, which will also archive their conversations. | | `close-conversation` | Closes a conversation in Intercom, marking it as resolved. Requires explicit user confirmation before calling; closing is irreversible without a separate reopen action. | | `create-contact` | Tool to create a new contact in Intercom workspace. Use when you need to add a user or lead to Intercom. | | `create-conversation` | Creates a new conversation in Intercom. Requires exactly one of from\_user\_id or from\_contact\_id - both are schema-optional but at least one must be provided. | | `create-tag` | Tool to create or update a tag, and optionally tag/untag companies or tag contacts. | | `create-ticket` | Tool to create a ticket in Intercom to track customer requests and issues. | | `get-conversation` | Retrieves a specific conversation by ID with all messages and details. | | `get-ticket` | Tool to retrieve a ticket from Intercom. Use when you need to fetch comprehensive details about a specific ticket including state, type, attributes, and contacts. | | `list-all-macros` | Tool to fetch a list of all macros (saved replies) in your workspace for use in automating responses. | | `list-contacts` | Tool to list all contacts (users or leads) in your Intercom workspace with pagination support. | | `list-conversations` | Lists all conversations from Intercom with pagination support. | | `list-segments` | Tool to retrieve all segments defined within a workspace for filtering and categorizing contacts. | | `list-tags` | Tool to fetch all tags for the workspace. Use when you need to retrieve all available tags that can be applied to contacts, companies, and conversations. | | `list-teams` | Tool to retrieve all teams within a workspace. Use when you need to get a list of all available teams, their members, or assignment configurations. | | `reopen-conversation` | Reopens a closed conversation in Intercom. Only operates correctly on conversations in a closed state; verify state via INTERCOM\_GET\_CONVERSATION... | | `reply-ticket` | Tool to reply to a ticket with a message from admin or contact, or with a note for admins. | | `reply-to-conversation` | Sends a reply to an existing conversation in Intercom. Always send reply before closing a conversation - never parallelize with... | | `retrieve-segment` | Tool to retrieve details for a single segment by its ID. Use when you need to get information about a specific segment including its name, type, and... | | `retrieve-team` | Tool to retrieve detailed information about a specific team by ID. | | `search-contacts` | Tool to search for contacts using query filters with operators. | | `search-conversations` | Searches for conversations using query string with support for filtering and sorting | | Tool | What it does | | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-subscription-to-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... | | `add-tag-to-contact` | Tool to add a tag to a contact in Intercom. Use when you need to attach or add a specific tag to a contact for categorization or tracking purposes. | | `archive-contact` | Tool to archive a single contact in Intercom. Use when you need to archive a contact by their ID. | | `assign-conversation` | Assigns a conversation to a specific admin or team in Intercom. | | `attach-contact-to-company` | Tool to attach a contact to a company in Intercom. Use when you need to associate a contact with a company. | | `attach-contact-to-conversation` | Tool to attach a contact participant to a conversation on behalf of admin or contact. | | `attach-tag-to-conversation` | Tool to add a tag to a specific conversation in Intercom. Use when you need to attach or tag a conversation. | | `attach-tag-to-ticket` | Tool to add a tag to a ticket in Intercom. Use when you need to attach or add a specific tag to a ticket for categorization or tracking purposes. | | `block-contact` | Tool to block a single contact in Intercom. Use when you need to block a contact, which will also archive their conversations. | | `cancel-data-export` | Tool to cancel an active content data export job. Use when you need to terminate an ongoing export and update its status to 'canceled'. | | `close-conversation` | Closes a conversation in Intercom, marking it as resolved. Requires explicit user confirmation before calling; closing is irreversible without a separate reopen action. | | `create-collection` | You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.` | | `create-article` | You can create a new article by making a POST request to `https://api.intercom.io/articles`. | | `create-note` | You can add a note to a single contact. | | `create-contact` | Tool to create a new contact in Intercom workspace. Use when you need to add a user or lead to Intercom. | | `create-content-import-source` | Tool to create a new content import source for the Fin Content Library. | | `create-conversation` | Creates a new conversation in Intercom. Requires exactly one of from\_user\_id or from\_contact\_id - both are schema-optional but at least one must be provided. | | `create-data-attribute` | Tool to create a custom data attribute for contacts or companies. | | `create-data-event` | Tool to submit a data event to Intercom to track user activities. | | `create-data-export` | Tool to initiate an async data export job for message content. | | `create-external-page` | Tool to create an external page in Fin Content Library or update an existing page by external ID. | | `create-help-center-section` | Tool to create a new help center section within a collection. | | `create-internal-article` | Tool to create a new internal article for team knowledge sharing. | | `create-or-update-company` | You can create or update a company. Companies will be only visible in Intercom when there is at least one associated user. | | `create-tag` | Tool to create or update a tag, and optionally tag/untag companies or tag contacts. | | `create-ticket` | Tool to create a ticket in Intercom to track customer requests and issues. | | `create-ticket-type` | Tool to create a new ticket type that defines the data structure for tracking customer requests. | | `create-ticket-type-attribute` | Tool to create a new attribute for a ticket type in Intercom. | | `data-event-summaries` | Tool to create event summaries for a user to track event occurrences. | | `delete-collection` | You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`. | | `delete-company` | You can delete a single company. | | `delete-article` | You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`. | | `delete-tag-delete-tag` | Tool to delete a tag from Intercom workspace. Use when you need to permanently remove a tag that is no longer needed. | | `delete-visitor` | Tool to delete a visitor from the Intercom workspace. Use when you need to permanently remove a visitor record. | | `delete-contact` | Tool to delete a contact from the Intercom workspace. Use when you need to permanently remove a contact record. | | `delete-content-import-source` | Tool to delete a content import source and all its external pages. | | `delete-external-page` | Tool to delete an external page from content library and AI answers. | | `delete-internal-article` | Tool to delete a single internal article by ID. Use when you need to permanently remove an internal article from Intercom. | | `delete-ticket` | Tool to delete a ticket from the Intercom system. Use when you need to permanently remove a ticket. | | `detach-contact` | Tool to remove a tag from a specific contact in Intercom. Use when you need to detach or untag a contact. | | `detach-contact-from-company` | Tool to detach a contact from a company in Intercom. Use when you need to remove a company association from a contact. | | `detach-tag-from-conversation` | Tool to remove a tag from a specific conversation in Intercom. | | `detach-tag-from-ticket` | Tool to remove a tag from a ticket in Intercom. Use when you need to detach or remove a specific tag from a ticket. | | `download-data-export` | Tool to download content data export from Intercom. Use when you need to retrieve exported message data from a completed data export job. | | `enqueue-create-ticket` | Tool to enqueue ticket creation for asynchronous processing. | | `find-tag` | Tool to retrieve details for a specific tag by its ID. Use when you need to get information about a particular tag in the workspace. | | `get-contact` | You can fetch the details of a single contact. | | `get-content-import-source` | Tool to retrieve a content import source by its ID. Use when you need to fetch details about a specific content import source from Intercom's AI features. | | `get-conversation` | Retrieves a specific conversation by ID with all messages and details. | | `get-counts` | Tool to retrieve summary counts for Intercom app entities including companies, users, leads, tags, segments, and conversations. | | `get-custom-object-instance-by-external-id` | Tool to retrieve a custom object instance by its external\_id. | | `get-external-page` | Tool to retrieve an external page from Fin Content Library by ID. | | `get-ticket` | Tool to retrieve a ticket from Intercom. Use when you need to fetch comprehensive details about a specific ticket including state, type, attributes, and contacts. | | `get-ticket-type` | Tool to retrieve details for a specific ticket type by its ID. | | `identify-admin` | You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). > ๐Ÿšง Single Sign On > > If you... | | `jobs-status` | Tool to retrieve the status of job execution. Use when checking progress and outcome of asynchronous operations like data imports or exports. | | `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? > >... | | `list-all-collections` | You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`. | | `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. | | `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-macros` | Tool to fetch a list of all macros (saved replies) in your workspace for use in automating responses. | | `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-away-status-reasons` | Tool to retrieve all away status reasons for a workspace including deleted ones. | | `list-calls` | Tool to list all phone calls from Intercom with pagination support. | | `list-calls-with-transcripts` | Tool to retrieve calls by conversation IDs with transcripts when available. | | `list-company-notes` | Tool to list all notes associated with a specific company. Use when you need to retrieve all notes that have been added to a company record. | | `list-contacts` | Tool to list all contacts (users or leads) in your Intercom workspace with pagination support. | | `list-content-import-sources` | Tool to retrieve all content import sources for the workspace. | | `list-conversations` | Lists all conversations from Intercom with pagination support. | | `list-data-attributes` | Tool to list all data attributes for contacts, companies, and conversations. | | `list-data-events` | Tool to retrieve a log of data events belonging to a customer. | | `list-external-pages` | Tool to list all external pages from Fin Content Library. Use when you need to retrieve external pages used for AI-generated answers in Intercom. | | `list-help-center-sections` | Tool to fetch a list of all help center sections in descending order by updated\_at. | | `list-internal-articles` | Fetches one page of internal articles from Intercom. Uses Intercom's cursor-based pagination via `starting_after`. | | `list-news-items` | Tool to fetch a list of all news items from Intercom. Use when you need to retrieve news items posted in the workspace. | | `list-segments` | Tool to retrieve all segments defined within a workspace for filtering and categorizing contacts. | | `list-subscriptions-for-contact` | You can fetch a list of subscription types that are attached to a contact. | | `list-subscription-types` | Tool to list all subscription types available in the workspace. | | `list-tags` | Tool to fetch all tags for the workspace. Use when you need to retrieve all available tags that can be applied to contacts, companies, and conversations. | | `list-tags-attached-to-contact` | You can fetch a list of all tags that are attached to a specific contact. | | `list-teams` | Tool to retrieve all teams within a workspace. Use when you need to get a list of all available teams, their members, or assignment configurations. | | `list-ticket-states` | Tool to fetch all ticket states for the workspace. Use when you need to retrieve all configured ticket states, including both active and archived ones. | | `list-ticket-types` | Tool to retrieve all ticket types for the workspace. Use when you need to get all available ticket type configurations including attributes and states. | | `merge-lead-and-user` | You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`. | | `register-fin-voice-call` | Tool to register a Fin Voice call with Intercom. Use when you need to create a record of an external voice call in Intercom, enabling AI-powered call... | | `remove-subscription-from-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-contact` | You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. | | `reopen-conversation` | Reopens a closed conversation in Intercom. Only operates correctly on conversations in a closed state; verify state via INTERCOM\_GET\_CONVERSATION... | | `reply-ticket` | Tool to reply to a ticket with a message from admin or contact, or with a note for admins. | | `reply-to-conversation` | Sends a reply to an existing conversation in Intercom. Always send reply before closing a conversation - never parallelize with... | | `retrieve-collection` | You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`. | | `retrieve-company-by-id` | You can fetch a single company. | | `retrieve-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/`. | | `retrieve-job-status` | Tool to retrieve the status of a data export job. Use when checking the progress of an export job by providing the job identifier. | | `retrieve-macro` | Tool to fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings. | | `retrieve-admin` | You can retrieve the details of a single admin. | | `retrieve-article` | You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`. | | `retrieve-segment` | Tool to retrieve details for a single segment by its ID. Use when you need to get information about a specific segment including its name, type, and... | | `retrieve-companies` | You can fetch a single company by passing in `company_id` or `name`. | | `retrieve-internal-article` | Tool to retrieve an internal article by ID from Intercom. Use when you need to fetch details of a specific internal article including its title, body... | | `retrieve-note` | Tool to retrieve details of a single note by its identifier. | | `retrieve-team` | Tool to retrieve detailed information about a specific team by ID. | | `retrieve-visitor-with-user-id` | Tool to retrieve a specific visitor's details using their user\_id. | | `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. | | `search-contacts` | Tool to search for contacts using query filters with operators. | | `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`. | | `search-internal-articles` | Searches one page of internal articles in Intercom. Uses Intercom's cursor-based pagination via `starting_after`. | | `search-tickets` | Tool to search tickets in Intercom by filtering attribute values. | | `set-admin-to-away` | You can set an Admin as away for the Inbox. | | `show-call` | Tool to retrieve a single call by ID from Intercom. Use when you need to get detailed information about a specific phone call. | | `show-call-transcript` | Tool to get call transcript by call ID. Use when you need to retrieve the transcript text from a recorded call. | | `show-contact-by-external-id` | Tool to retrieve a contact by their external ID. Use when you need to fetch contact details using an identifier from your external system rather than... | | `unarchive-contact` | Tool to unarchive a previously archived contact in Intercom. | | `update-collection` | You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`. | | `update-company` | You can update a single company using the Intercom provisioned `id`. \{% admonition type="attention" name="Using `company_id`" %} When updating a... | | `update-contact` | Tool to update an existing contact in Intercom. Use when you need to modify contact information such as name, email, custom attributes, or other properties. | | `update-article` | You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`. | | `update-content-import-source` | Tool to update an existing content import source in Fin Content Library. | | `update-data-attribute` | Tool to update an existing data attribute in Intercom. Use when you need to modify a data attribute's description, archive status, or messenger writability. | | `update-external-page` | Tool to update an existing external page in Fin Content Library. | | `update-internal-article` | Tool to update an internal article with new title, body, author or owner information. | | `update-ticket` | Tool to update an existing ticket in Intercom. Use when you need to modify ticket attributes, state, assignment, or other properties. | | `update-ticket-type` | Tool to update an existing ticket type in the workspace. Use when you need to modify a ticket type's name, description, category, icon, or archive status. | | `update-ticket-type-attribute` | Tool to update an existing attribute for a ticket type. Use when you need to modify properties like description, visibility, or requirements for a ticket type attribute. | [Open Intercom in the console โ†’](https://app.boxd.sh/integrations/detail/intercom)