Reference

Get entity counts

Retrieve summary statistics about your Intercom workspace including total counts of companies, users, leads, tags, segments, and conversations. Use this to monitor the size and activity level of your customer base and communication channels.

Create an article

Create a new help article in your Intercom knowledge base to provide self-service support content for your customers. This allows you to build a comprehensive library of documentation and FAQs that reduce support ticket volume.

Create internal article

Creates internal documentation articles that your team can access and reference, helping centralize knowledge and best practices without publishing them publicly.

Delete an article

Permanently remove an article from your knowledge base, allowing you to manage outdated or incorrect content that customers can no longer access.

Delete internal article

Permanently removes an internal article from your Intercom knowledge base so it's no longer available to your team or customers. Use this when an article becomes outdated, irrelevant, or needs to be replaced with newer information.

Create data attribute

Create custom data attributes to track additional information about your contacts or companies beyond Intercom's standard fields. This lets you organize and segment your customers based on business-specific data that matters to your operations.

Create a collection

Create a new collection in your help center to organize and group related articles together for better content structure and customer navigation.

Delete a collection

Permanently remove a collection from your Intercom knowledge base, freeing up space and maintaining an organized help resource library.

Attach contact to company

Links an individual contact to a company account in Intercom, enabling you to organize customer relationships and track interactions by company.

Create or update a company

Create a new company profile in Intercom or update an existing one with the latest information like name, industry, and billing details. This keeps your customer organization data synchronized with your communication platform.

Delete a company

Remove a company record from your Intercom workspace when it's no longer relevant or needs to be purged from your system.

Detach contact from company

Remove a company association from a contact in Intercom, allowing you to clean up contact records and reorganize customer relationships when needed.

Create contact

Adds a new customer, prospect, or team member to your Intercom workspace so you can track their interactions and communicate with them directly. This is essential for maintaining an organized customer database and enabling personalized support.

Archive contact

Remove a contact from your active Intercom list by archiving them, keeping their conversation history intact while decluttering your contact database.

Block contact

Prevent unwanted contacts from reaching you by blocking them in Intercom, which automatically archives all their past conversations to keep your workspace clean.

Delete a contact

Permanently remove a contact record from your Intercom workspace to clean up duplicate or inactive customer profiles.

Get a contact

Retrieve detailed information about a specific contact including their communication history, attributes, and engagement data. Use this to access up-to-date contact details for customer support, outreach, or relationship management.

Create content import source

Set up a new content source to feed external pages and resources into Intercom's AI-powered knowledge library, enabling your support team to provide more accurate and consistent customer answers.

Delete content import source

Remove a content import source and all associated external pages from Intercom, freeing up space and cleaning up outdated integrations. This action is permanent and cannot be reversed.

Get content import source

Retrieve detailed information about a specific content import source you've set up in Intercom, such as the source type, status, and configuration details. This helps you verify import settings and manage your knowledge base sources.

Assign conversation

Assign a customer conversation to a specific team member or group in Intercom to ensure the right person handles customer inquiries.

Attach contact to conversation

Add a contact or team member to an existing customer conversation, enabling collaborative support and expanding conversation access to relevant participants.

Close conversation

Marks a customer conversation as resolved and closed in Intercom. Use this after providing your final response to prevent further messages on that ticket.

Create conversation

Initiates a new customer conversation in Intercom by specifying either a user or contact, allowing you to start support interactions, follow-ups, or sales outreach programmatically.

Get conversation

Retrieves a complete conversation thread including all messages, customer details, and conversation history from your Intercom inbox. Use this when you need the full context of a customer interaction for reference or action.

Create data event

Submit a data event to Intercom to track and record specific user actions and behaviors, helping you understand customer engagement patterns and activity history.

Create event summaries

Track and bulk update event counts for your users, allowing you to record important customer actions and interactions in one go.

Cancel data export

Stops an active data export job and marks it as canceled, allowing you to halt large exports that are no longer needed or were initiated by mistake.

Create data export

Initiates an asynchronous export of your message data within a specified timeframe, allowing you to download and archive conversations for backup or analysis purposes.

Download data export

Retrieve exported customer message data from Intercom as a compressed CSV file for analysis and record-keeping. This allows you to access completed data exports containing your conversation history and customer interactions.

Create help center section

Organize help center articles by creating new sections within collections, making it easier for customers to find information by topic. This helps you build a structured knowledge base that scales as your business grows.

Create a note

Add internal notes to a contact's profile to track important details, conversations, or follow-ups without the contact seeing them. This helps you and your team stay organized and remember key context for future interactions.

Create external page

Create or update content pages in your Intercom knowledge base that power AI-generated customer support answers, enabling you to maintain up-to-date resources for your support team.

Delete external page

Remove an external page from your Intercom knowledge base so your AI assistant no longer references outdated or incorrect information in customer conversations.

Add subscription to a contact

Manage a contact's subscription preferences by adding them to a specific subscription type, allowing you to control whether they receive messages related to that subscription category based on your consent model.

Add tag to contact

Attach labels to your customer contacts in Intercom to organize and categorize them for better tracking and segmentation. This helps you quickly identify customers by type, status, or other important attributes.

Create or update tag

Create new tags or update existing ones, and apply them to contacts or companies to organize and categorize your customer base. This helps you segment customers for targeted communication and better customer management.

Attach tag to conversation

Add a tag to a conversation to organize, categorize, and track customer interactions for better support management. This helps you quickly identify and filter conversations by type, priority, or status.

Attach tag to ticket

Adds a tag to a support ticket in Intercom for better organization and tracking. This helps you categorize customer issues by type, priority, or status for easier management and reporting.

Delete a tag

Permanently remove a tag from your Intercom workspace to clean up your customer communication system and keep your tagging structure organized.

Detach a contact from tag

Remove a tag from a contact in Intercom to update their categorization or status. This helps you keep your contact organization clean as customer relationships and needs evolve.

Detach tag from conversation

Remove a tag from a conversation in Intercom to keep your support tickets organized and accurate as their status or context changes. This helps maintain clean labeling and prevents outdated categorizations from cluttering your support workflow.

Detach tag from ticket

Remove a tag from a support ticket in Intercom, helping you keep ticket categories and organization up-to-date as issues evolve or are miscategorized.

Find a tag

Retrieve detailed information about a specific tag in your Intercom workspace by its ID. Use this to look up tag properties and understand how tags are being used in your customer communication system.

Create ticket

Creates a new support ticket in Intercom to track and manage customer requests, issues, or feedback in a centralized location. This helps you organize customer problems and ensure nothing falls through the cracks.

Create a ticket type

Create a new ticket type that defines how customer requests are tracked and categorized with custom fields and states. Use this to establish structured ticket categories tailored to your specific support workflow.

Create ticket type attribute

Adds custom fields or properties to your ticket types in Intercom, allowing you to capture and organize specific information relevant to your support process.

Delete ticket

Permanently removes a support ticket from your Intercom system, useful when you need to clean up duplicate, test, or resolved tickets that are no longer needed.

Enqueue create ticket

Submits a customer support ticket to Intercom's processing queue, ensuring it's created even during high-volume periods without blocking your workflow. This asynchronous approach lets you continue working while the ticket is being processed in the background.

Delete a visitor

Permanently remove a visitor record from your Intercom workspace to keep your contact database clean and up-to-date.

Get a ticket type

Tool to retrieve details for a specific ticket type by its ID.

Get custom object instance by external ID

Tool to retrieve a custom object instance by its externalid.

Get external page

Tool to retrieve an external page from Fin Content Library by ID.

Get ticket

Tool to retrieve a ticket from Intercom.

Identify an admin

You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).

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.

List all collections

You can fetch a list of all collections by making a GET request to https://api.intercom.io/helpcenter/collections.

List all companies

You can list companies.

List all contacts

Tool to list all contacts (users or leads) in your Intercom workspace with pagination support.

List all help centers

You can list all Help Centers by making a GET request to https://api.intercom.io/helpcenter/helpcenters.

List all macros

Tool to fetch a list of all macros (saved replies) in your workspace for use in automating responses.

List all news items

Tool to fetch a list of all news items from Intercom.

List all notes

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

List all segments

Tool to retrieve all segments defined within a workspace for filtering and categorizing contacts.

List all tags

Tool to fetch all tags for the workspace.

List all teams

Tool to retrieve all teams within a workspace.

List all ticket states

Tool to fetch all ticket states for the workspace.

List all ticket types

Tool to retrieve all ticket types for the workspace.

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.

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.

List help center sections

Tool to fetch a list of all help center sections in descending order by updatedat.

List internal articles

Fetches one page of internal articles from Intercom.

List subscription types

Tool to list all subscription types available in the workspace.

List subscriptions for a contact

You can fetch a list of subscription types that are attached to a contact.

List tags attached to a contact

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

Merge a lead and a 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.

Remove subscription from a contact

You can remove a specific subscription from a contact.

Remove tag from a contact

You can remove tag from a specific contact.

Reopen conversation

Reopens a closed conversation in Intercom.

Reply to conversation

Sends a reply to an existing conversation in Intercom.

Reply to ticket

Tool to reply to a ticket with a message from admin or contact, or with a note for admins.

Retrieve a collection

You can fetch the details of a single collection by making a GET request to https://api.intercom.io/helpcenter/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/helpcenter/helpcenter/<id>.

Retrieve a macro

Tool to fetch a single macro (saved reply) by its ID.

Retrieve a segment

Tool to retrieve details for a single segment by its ID.

Retrieve a team

Tool to retrieve detailed information about a specific team by ID.

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 companies

You can fetch a single company by passing in companyid or name.

Retrieve internal article

Tool to retrieve an internal article by ID from Intercom.

Retrieve job status

Tool to retrieve the status of job execution.

Retrieve job status

Tool to retrieve the status of a data export job.

Retrieve note

Tool to retrieve details of a single note by its identifier.

Retrieve visitor with user ID

Tool to retrieve a specific visitor's details using their userid.

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.

Search tickets

Tool to search tickets in Intercom by filtering attribute values.

Set admin to away

Tool to set an admin to away status in Intercom.

Set an 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.

Show call transcript

Tool to get call transcript by call ID.

Show contact by external ID

Tool to retrieve a contact by their external ID.

Unarchive contact

Tool to unarchive a previously archived contact in Intercom.

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.

Update a contact

You can update an existing contact (ie.

Update a ticket type

Tool to update an existing ticket type in the workspace.

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 contact

Tool to update an existing contact in Intercom.

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.

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.

Update ticket type attribute

Tool to update an existing attribute for a ticket type.