Intercom

Tool to search for contacts using query filters with operators. Use when finding contacts by role, email, name, or attributes. Response entries may include null or non-dictionary values; guard against missing/null fields before accessing nested properties. A contact may have multiple emails or contact_ids; deduplicate when aggregating across searches.

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

Tool to search tickets in Intercom by filtering attribute values. Use when you need to find tickets matching specific criteria like state, creation date, assignment, or custom attributes.

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 Intercom's internal ID. Only supports users, not leads.

Tool to initiate an async data export job for message content. Use when you need to export messages created within a specific timeframe. Only one active job per workspace is allowed; exceeding this limit triggers a 429 error. Jobs expire two days after completion.

Tool to download content data export from Intercom. Use when you need to retrieve exported message data from a completed data export job. The data is returned as a gzipped CSV file stream.

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.

You can fetch the details of a single contact.

Tool to retrieve details for a specific ticket type by its ID. Use when you need to get complete information about a ticket type including its attributes and states.

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.

Tool to retrieve a custom object instance by its external_id. Use when you need to fetch a specific custom object instance from Intercom using an identifier from your external system rather than Intercom's internal ID.

Tool to retrieve summary counts for Intercom app entities including companies, users, leads, tags, segments, and conversations. Use when you need to get statistics about the total number of entities in the workspace or conversation counts.

Tool to retrieve an external page from Fin Content Library by ID. Use when you need to fetch details of a specific external page including its content, metadata, and AI availability settings.

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 for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

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

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

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.

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.

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. {% 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 for more details on how to use the `starting_after` param. {% /admonition %}

You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.

Tool to fetch a list of all news items from Intercom. Use when you need to retrieve news items posted in the workspace.

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

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.

Tool to retrieve all ticket types for the workspace. Use when you need to get all available ticket type configurations including attributes and states.

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

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

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

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

Tool to retrieve all away status reasons for a workspace including deleted ones. Use when you need to list available away status options for team members.

Tool to list all phone calls from Intercom with pagination support. Use when you need to retrieve call records, view call history, or iterate through calls.

Tool to retrieve calls by conversation IDs with transcripts when available. Use when you need to get call records with their transcripts for specific conversations. Maximum 20 conversation IDs per request.

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.

Tool to retrieve all content import sources for the workspace. Use when you need to list all content sources for Fin Content Library.

Tool to list all data attributes for contacts, companies, and conversations. Use when you need to retrieve metadata about available data attributes.

Tool to retrieve a log of data events belonging to a customer. Use when you need to list events for a specific user. Note: Only events less than 90 days old can be listed.

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.

Tool to fetch a list of all help center sections in descending order by updated_at. Use when you need to retrieve sections from the help center hierarchy (Help Center → Collections → Sections → Articles).

Fetches one page of internal articles from Intercom. Uses Intercom's cursor-based pagination via `starting_after`. ONE Intercom API call is made per invocation; pagination is caller-driven via the `starting_after` request parameter and the `next_starting_after` field in the response.

Tool to list all subscription types available in the workspace. Use when you need to retrieve subscription configuration details including state, translations, consent type, and supported content types.

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 will return a list of Subscription Type objects that the contact is associated with. The data property will show a combined list of: 1.Opt-out subscription types that the user has opted-out from. 2.Opt-in subscription types that the user has opted-in to receiving.

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

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

You can fetch a single company.

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>`.

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.

You can retrieve the details of a single admin.

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

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 companies and filter by `segment_id` or `tag_id` as a query parameter. `https://api.intercom.io/companies?tag_id={tag_id}` `https://api.intercom.io/companies?segment_id={segment_id}`

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 content, and metadata.

Tool to retrieve the status of job execution. Use when checking progress and outcome of asynchronous operations like data imports or exports.

Tool to retrieve the status of a data export job. Use when checking the progress of an export job by providing the job identifier.

Tool to retrieve details of a single note by its identifier. Use when you need to fetch the complete information about a specific note.

Tool to retrieve a specific visitor's details using their user_id. Use when you need to fetch comprehensive visitor information including profile data, location, and activity metrics.

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 iterating over all companies in a dataset. - Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. You can get the first page of companies by simply sending a GET request to the scroll endpoint. For subsequent requests you will need to use the scroll parameter from the response type="danger" name="Scroll network timeouts". Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: "Request failed due to an internal network error. Please restart the scroll operation." If this happens, you will need to restart your scroll query.

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

Searches one page of internal articles in Intercom. Uses Intercom's cursor-based pagination via `starting_after`. ONE Intercom API call is made per invocation; pagination is caller-driven via the `starting_after` request parameter and the `next_starting_after` field in the response. Optionally filtered by `folder_id`.

Tool to retrieve a single call by ID from Intercom. Use when you need to get detailed information about a specific phone call.

Tool to get call transcript by call ID. Use when you need to retrieve the transcript text from a recorded call.

Tool to submit a data event to Intercom to track user activities. Use when you need to notify Intercom of user actions and changes. Events are detected as duplicates using workspace ID, contact identifier, event name, and timestamp.

Tool to create a new help center section within a collection. Use when you need to add a new section to organize articles in the help center hierarchy (Help Center → Collections → Sections → Articles). Supports multilingual content via translated_content parameter.

Tool to create a new internal article for team knowledge sharing. Use when you need to add new internal documentation or knowledge base articles for team members.

Tool to create a new attribute for a ticket type in Intercom. Use when you need to add custom attributes to ticket types for data collection.

Tool to enqueue ticket creation for asynchronous processing. Use when you need to create a ticket in Intercom. The system attempts validation on inputs before tasks are enqueued.

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 analysis and customer interaction tracking.

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.

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.

Tool to add a tag to a specific conversation in Intercom. Use when you need to attach or tag a conversation.

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.

Tool to create event summaries for a user to track event occurrences. Use when you need to bulk update event counts for a user.

Tool to create an external page in Fin Content Library or update an existing page by external ID. Use when you need to ingest new content or update existing content for AI-generated answers. Supports upsert behavior: if a page with the same source_id and external_id exists, it will be updated instead of creating a new one.

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 %}

You can set an Admin as away for the Inbox.

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

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`. This can only be set once upon creation of the company. {% /admonition %}

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

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.

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

Tool to update an existing content import source in Fin Content Library. Use when you need to modify the URL, sync behavior, or status of an existing content import source.

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. Note: Changing a data attribute's type via the API is restricted and must be done through the UI.

Tool to update an existing external page in Fin Content Library. Use when you need to modify the content, metadata, or availability settings of an external page. Only pages created through the API can be updated.

Tool to update an internal article with new title, body, author or owner information. Use when you need to modify an existing internal article in Intercom.

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.

Tool to delete a content import source and all its external pages. Use when you need to remove a content import source from Intercom. This operation is permanent and cannot be undone.

Tool to delete an external page from content library and AI answers. Use when you need to remove an external page from Intercom's AI knowledge base.

Tool to delete a single internal article by ID. Use when you need to permanently remove an internal article from Intercom.

Tool to delete a ticket from the Intercom system. Use when you need to permanently remove a ticket.

Tool to remove a tag from a specific contact in Intercom. Use when you need to detach or untag a contact.

Tool to detach a contact from a company in Intercom. Use when you need to remove a company association from a contact.

Tool to remove a tag from a specific conversation in Intercom. Use when you need to detach or untag a conversation.

Tool to remove a tag from a ticket in Intercom. Use when you need to detach or remove a specific tag from a ticket.

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

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.

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