Summary
This connects Claude to Intercom's customer data through a hosted gateway that handles OAuth for you. You get five tools: search and retrieve contacts by email or attributes, list and fetch full conversation threads with message history, and browse companies with their metadata. It's part of Pipeworx's broader integration platform, so you can either use the dedicated Intercom endpoint or connect to their main gateway for access to 600+ other data sources. Worth grabbing if you're building support workflows, enriching customer context during conversations, or need to pull Intercom data into Claude without spinning up your own server.
Keep your Mac awake while Claude Code and 40+ AI agents run. Sleeps when they're idle.
One time payment $9 →
Integrate web data into your AI product. One API to scrape website & brand data.
Get API Key Now →
Agent, run crypto. Access onchain data & trade routes via 1inch.
Install now →
On Capafy, your Skill runs online 24/7 as an agent product, and you get paid every time someone uses it.
Start earning →
Tools
Public tool metadata for what this MCP can expose to an agent.
51 tools
INTERCOM_ADD_SUBSCRIPTION_TO_A_CONTACTYou 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...3 params
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...
Parameters* required
idstringThe unique identifier for the subscription which is given by Intercom
contact_idstringThe unique identifier for the contact which is given by Intercom
consent_typestringThe consent_type of a subscription, opt_out or opt_in.
INTERCOM_ADD_TAG_TO_A_CONTACTYou can tag a specific contact. This will return a tag object for the tag that was added to the contact.2 params
You can tag a specific contact. This will return a tag object for the tag that was added to the contact.
Parameters* required
idstringThe unique identifier for the tag which is given by Intercom
contact_idstringThe unique identifier for the contact which is given by Intercom
INTERCOM_ASSIGN_CONVERSATIONAssigns a conversation to a specific admin or team in Intercom4 params
Assigns a conversation to a specific admin or team in Intercom
Parameters* required
team_idstringID of the team to assign the conversation to. Either admin_id or team_id must be provided
admin_idstringID of the admin to assign the conversation to. Either admin_id or team_id must be provided
assignee_idstringID of the admin making the assignment (who is performing this action)
conversation_idstringThe ID of the conversation to assign
INTERCOM_ATTACH_A_CONTACT_TO_A_COMPANYYou can attach a company to a single contact.1 params
You can attach a company to a single contact.
Parameters* required
idstringThe unique identifier for the company which is given by Intercom
INTERCOM_CLOSE_CONVERSATIONCloses a conversation in Intercom, marking it as resolved3 params
Closes a conversation in Intercom, marking it as resolved
Parameters* required
bodystringOptional message to send when closing the conversation
admin_idstringID of the admin closing the conversation
conversation_idstringThe ID of the conversation to close
INTERCOM_CREATE_A_COLLECTIONYou can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`116 params
You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`
Parameters* required
namestringThe name of the collection. For multilingual collections, this will be the name of the default language"s content.
parent_idstringThe id of the parent collection. If `null` then it will be created as the first level collection.
descriptionstringThe description of the collection. For multilingual collections, this will be the description of the default language"s content.
help_center_idintegerThe id of the help center where the collection will be created. If `null` then it will be created in the default help center.
translated__content__typestringThe type of object - group_translated_content.one of
None · group_translated_contenttranslated__content__ar__namestringThe name of the collection or section.
translated__content__ar__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__bg__namestringThe name of the collection or section.
translated__content__bg__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__bs__namestringThe name of the collection or section.
translated__content__bs__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__ca__namestringThe name of the collection or section.
translated__content__ca__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__cs__namestringThe name of the collection or section.
translated__content__cs__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__da__namestringThe name of the collection or section.
translated__content__da__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__de__namestringThe name of the collection or section.
translated__content__de__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__el__namestringThe name of the collection or section.
translated__content__el__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__en__namestringThe name of the collection or section.
translated__content__en__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__es__namestringThe name of the collection or section.
translated__content__es__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__et__namestringThe name of the collection or section.
translated__content__et__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__fi__namestringThe name of the collection or section.
translated__content__fi__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__fr__namestringThe name of the collection or section.
translated__content__fr__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__he__namestringThe name of the collection or section.
translated__content__he__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__hr__namestringThe name of the collection or section.
translated__content__hr__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__hu__namestringThe name of the collection or section.
translated__content__hu__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__id__namestringThe name of the collection or section.
translated__content__id__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__it__namestringThe name of the collection or section.
translated__content__it__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__ja__namestringThe name of the collection or section.
translated__content__ja__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__ko__namestringThe name of the collection or section.
translated__content__ko__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__lt__namestringThe name of the collection or section.
translated__content__lt__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__lv__namestringThe name of the collection or section.
translated__content__lv__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__mn__namestringThe name of the collection or section.
translated__content__mn__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__nb__namestringThe name of the collection or section.
translated__content__nb__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__nl__namestringThe name of the collection or section.
translated__content__nl__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__pl__namestringThe name of the collection or section.
translated__content__pl__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__pt__namestringThe name of the collection or section.
translated__content__pt__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__ro__namestringThe name of the collection or section.
translated__content__ro__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__ru__namestringThe name of the collection or section.
translated__content__ru__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__sl__namestringThe name of the collection or section.
translated__content__sl__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__sr__namestringThe name of the collection or section.
translated__content__sr__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__sv__namestringThe name of the collection or section.
translated__content__sv__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__tr__namestringThe name of the collection or section.
translated__content__tr__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__vi__namestringThe name of the collection or section.
translated__content__vi__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__pt__BR__namestringThe name of the collection or section.
translated__content__pt__BR__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__zh__CN__namestringThe name of the collection or section.
translated__content__zh__CN__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__zh__TW__namestringThe name of the collection or section.
translated__content__zh__TW__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__ar__descriptionstringThe description of the collection. Only available for collections.
translated__content__bg__descriptionstringThe description of the collection. Only available for collections.
translated__content__bs__descriptionstringThe description of the collection. Only available for collections.
translated__content__ca__descriptionstringThe description of the collection. Only available for collections.
translated__content__cs__descriptionstringThe description of the collection. Only available for collections.
translated__content__da__descriptionstringThe description of the collection. Only available for collections.
translated__content__de__descriptionstringThe description of the collection. Only available for collections.
translated__content__el__descriptionstringThe description of the collection. Only available for collections.
translated__content__en__descriptionstringThe description of the collection. Only available for collections.
translated__content__es__descriptionstringThe description of the collection. Only available for collections.
translated__content__et__descriptionstringThe description of the collection. Only available for collections.
translated__content__fi__descriptionstringThe description of the collection. Only available for collections.
translated__content__fr__descriptionstringThe description of the collection. Only available for collections.
translated__content__he__descriptionstringThe description of the collection. Only available for collections.
translated__content__hr__descriptionstringThe description of the collection. Only available for collections.
translated__content__hu__descriptionstringThe description of the collection. Only available for collections.
translated__content__id__descriptionstringThe description of the collection. Only available for collections.
translated__content__it__descriptionstringThe description of the collection. Only available for collections.
translated__content__ja__descriptionstringThe description of the collection. Only available for collections.
translated__content__ko__descriptionstringThe description of the collection. Only available for collections.
translated__content__lt__descriptionstringThe description of the collection. Only available for collections.
translated__content__lv__descriptionstringThe description of the collection. Only available for collections.
translated__content__mn__descriptionstringThe description of the collection. Only available for collections.
translated__content__nb__descriptionstringThe description of the collection. Only available for collections.
translated__content__nl__descriptionstringThe description of the collection. Only available for collections.
translated__content__pl__descriptionstringThe description of the collection. Only available for collections.
translated__content__pt__descriptionstringThe description of the collection. Only available for collections.
translated__content__ro__descriptionstringThe description of the collection. Only available for collections.
translated__content__ru__descriptionstringThe description of the collection. Only available for collections.
translated__content__sl__descriptionstringThe description of the collection. Only available for collections.
translated__content__sr__descriptionstringThe description of the collection. Only available for collections.
translated__content__sv__descriptionstringThe description of the collection. Only available for collections.
translated__content__tr__descriptionstringThe description of the collection. Only available for collections.
translated__content__vi__descriptionstringThe description of the collection. Only available for collections.
translated__content__pt__BR__descriptionstringThe description of the collection. Only available for collections.
translated__content__zh__CN__descriptionstringThe description of the collection. Only available for collections.
translated__content__zh__TW__descriptionstringThe description of the collection. Only available for collections.
INTERCOM_CREATE_AN_ARTICLEYou can create a new article by making a POST request to `https://api.intercom.io/articles`.341 params
You can create a new article by making a POST request to `https://api.intercom.io/articles`.
Parameters* required
bodystringThe content of the article. For multilingual articles, this will be the body of the default language"s content.
statestringWhether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language"s content. one of
published · drafttitlestringThe title of the article.For multilingual articles, this will be the title of the default language"s content.
author_idintegerThe id of the author of the article. For multilingual articles, this will be the id of the author of the default language"s content. Must be a teammate on the help center"s workspace.
parent_idintegerThe id of the article"s parent collection or section. An article without this field stands alone.
descriptionstringThe description of the article. For multilingual articles, this will be the description of the default language"s content.
parent_typestringThe type of parent, which can either be a `collection` or `section`.
translated__content__typestringThe type of object - article_translated_content.one of
None · article_translated_contenttranslated__content__ar__urlstringThe URL of the article.
translated__content__bg__urlstringThe URL of the article.
translated__content__bs__urlstringThe URL of the article.
translated__content__ca__urlstringThe URL of the article.
translated__content__cs__urlstringThe URL of the article.
translated__content__da__urlstringThe URL of the article.
translated__content__de__urlstringThe URL of the article.
translated__content__el__urlstringThe URL of the article.
translated__content__en__urlstringThe URL of the article.
translated__content__es__urlstringThe URL of the article.
translated__content__et__urlstringThe URL of the article.
translated__content__fi__urlstringThe URL of the article.
translated__content__fr__urlstringThe URL of the article.
translated__content__he__urlstringThe URL of the article.
translated__content__hr__urlstringThe URL of the article.
translated__content__hu__urlstringThe URL of the article.
translated__content__id__urlstringThe URL of the article.
translated__content__it__urlstringThe URL of the article.
translated__content__ja__urlstringThe URL of the article.
translated__content__ko__urlstringThe URL of the article.
translated__content__lt__urlstringThe URL of the article.
translated__content__lv__urlstringThe URL of the article.
translated__content__mn__urlstringThe URL of the article.
translated__content__nb__urlstringThe URL of the article.
translated__content__nl__urlstringThe URL of the article.
translated__content__pl__urlstringThe URL of the article.
translated__content__pt__urlstringThe URL of the article.
translated__content__ro__urlstringThe URL of the article.
translated__content__ru__urlstringThe URL of the article.
translated__content__sl__urlstringThe URL of the article.
translated__content__sr__urlstringThe URL of the article.
translated__content__sv__urlstringThe URL of the article.
translated__content__tr__urlstringThe URL of the article.
translated__content__vi__urlstringThe URL of the article.
translated__content__ar__bodystringThe body of the article.
translated__content__ar__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__bg__bodystringThe body of the article.
translated__content__bg__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__bs__bodystringThe body of the article.
translated__content__bs__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__ca__bodystringThe body of the article.
translated__content__ca__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__cs__bodystringThe body of the article.
translated__content__cs__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__da__bodystringThe body of the article.
translated__content__da__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__de__bodystringThe body of the article.
translated__content__de__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__el__bodystringThe body of the article.
translated__content__el__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__en__bodystringThe body of the article.
translated__content__en__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__es__bodystringThe body of the article.
translated__content__es__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__et__bodystringThe body of the article.
translated__content__et__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__fi__bodystringThe body of the article.
translated__content__fi__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__fr__bodystringThe body of the article.
translated__content__fr__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__he__bodystringThe body of the article.
translated__content__he__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__hr__bodystringThe body of the article.
translated__content__hr__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__hu__bodystringThe body of the article.
translated__content__hu__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__id__bodystringThe body of the article.
translated__content__id__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__it__bodystringThe body of the article.
translated__content__it__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__ja__bodystringThe body of the article.
translated__content__ja__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__ko__bodystringThe body of the article.
translated__content__ko__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__lt__bodystringThe body of the article.
translated__content__lt__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__lv__bodystringThe body of the article.
translated__content__lv__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__mn__bodystringThe body of the article.
translated__content__mn__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__nb__bodystringThe body of the article.
translated__content__nb__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__nl__bodystringThe body of the article.
translated__content__nl__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__pl__bodystringThe body of the article.
translated__content__pl__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__pt__bodystringThe body of the article.
translated__content__pt__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__ro__bodystringThe body of the article.
translated__content__ro__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__ru__bodystringThe body of the article.
translated__content__ru__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__sl__bodystringThe body of the article.
translated__content__sl__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__sr__bodystringThe body of the article.
translated__content__sr__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__sv__bodystringThe body of the article.
translated__content__sv__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__tr__bodystringThe body of the article.
translated__content__tr__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__vi__bodystringThe body of the article.
translated__content__vi__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__ar__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__ar__titlestringThe title of the article.
translated__content__bg__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__bg__titlestringThe title of the article.
translated__content__bs__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__bs__titlestringThe title of the article.
translated__content__ca__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__ca__titlestringThe title of the article.
translated__content__cs__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__cs__titlestringThe title of the article.
translated__content__da__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__da__titlestringThe title of the article.
translated__content__de__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__de__titlestringThe title of the article.
translated__content__el__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__el__titlestringThe title of the article.
translated__content__en__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__en__titlestringThe title of the article.
translated__content__es__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__es__titlestringThe title of the article.
translated__content__et__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__et__titlestringThe title of the article.
translated__content__fi__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__fi__titlestringThe title of the article.
translated__content__fr__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__fr__titlestringThe title of the article.
translated__content__he__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__he__titlestringThe title of the article.
translated__content__hr__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__hr__titlestringThe title of the article.
translated__content__hu__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__hu__titlestringThe title of the article.
translated__content__id__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__id__titlestringThe title of the article.
translated__content__it__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__it__titlestringThe title of the article.
translated__content__ja__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__ja__titlestringThe title of the article.
translated__content__ko__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__ko__titlestringThe title of the article.
translated__content__lt__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__lt__titlestringThe title of the article.
translated__content__lv__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__lv__titlestringThe title of the article.
translated__content__mn__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__mn__titlestringThe title of the article.
translated__content__nb__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__nb__titlestringThe title of the article.
translated__content__nl__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__nl__titlestringThe title of the article.
translated__content__pl__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__pl__titlestringThe title of the article.
translated__content__pt__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__pt__titlestringThe title of the article.
translated__content__ro__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__ro__titlestringThe title of the article.
translated__content__ru__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__ru__titlestringThe title of the article.
translated__content__sl__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__sl__titlestringThe title of the article.
translated__content__sr__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__sr__titlestringThe title of the article.
translated__content__sv__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__sv__titlestringThe title of the article.
translated__content__tr__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__tr__titlestringThe title of the article.
translated__content__vi__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__vi__titlestringThe title of the article.
translated__content__pt__BR__urlstringThe URL of the article.
translated__content__zh__CN__urlstringThe URL of the article.
translated__content__zh__TW__urlstringThe URL of the article.
translated__content__pt__BR__bodystringThe body of the article.
translated__content__pt__BR__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__zh__CN__bodystringThe body of the article.
translated__content__zh__CN__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__zh__TW__bodystringThe body of the article.
translated__content__zh__TW__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__pt__BR__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__pt__BR__titlestringThe title of the article.
translated__content__zh__CN__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__zh__CN__titlestringThe title of the article.
translated__content__zh__TW__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__zh__TW__titlestringThe title of the article.
translated__content__ar__author__idintegerThe ID of the author of the article.
translated__content__bg__author__idintegerThe ID of the author of the article.
translated__content__bs__author__idintegerThe ID of the author of the article.
translated__content__ca__author__idintegerThe ID of the author of the article.
translated__content__cs__author__idintegerThe ID of the author of the article.
translated__content__da__author__idintegerThe ID of the author of the article.
translated__content__de__author__idintegerThe ID of the author of the article.
translated__content__el__author__idintegerThe ID of the author of the article.
translated__content__en__author__idintegerThe ID of the author of the article.
translated__content__es__author__idintegerThe ID of the author of the article.
translated__content__et__author__idintegerThe ID of the author of the article.
translated__content__fi__author__idintegerThe ID of the author of the article.
translated__content__fr__author__idintegerThe ID of the author of the article.
translated__content__he__author__idintegerThe ID of the author of the article.
translated__content__hr__author__idintegerThe ID of the author of the article.
translated__content__hu__author__idintegerThe ID of the author of the article.
translated__content__id__author__idintegerThe ID of the author of the article.
translated__content__it__author__idintegerThe ID of the author of the article.
translated__content__ja__author__idintegerThe ID of the author of the article.
translated__content__ko__author__idintegerThe ID of the author of the article.
translated__content__lt__author__idintegerThe ID of the author of the article.
translated__content__lv__author__idintegerThe ID of the author of the article.
translated__content__mn__author__idintegerThe ID of the author of the article.
translated__content__nb__author__idintegerThe ID of the author of the article.
translated__content__nl__author__idintegerThe ID of the author of the article.
translated__content__pl__author__idintegerThe ID of the author of the article.
translated__content__pt__author__idintegerThe ID of the author of the article.
translated__content__ro__author__idintegerThe ID of the author of the article.
translated__content__ru__author__idintegerThe ID of the author of the article.
translated__content__sl__author__idintegerThe ID of the author of the article.
translated__content__sr__author__idintegerThe ID of the author of the article.
translated__content__sv__author__idintegerThe ID of the author of the article.
translated__content__tr__author__idintegerThe ID of the author of the article.
translated__content__vi__author__idintegerThe ID of the author of the article.
translated__content__ar__created__atintegerThe time when the article was created (seconds).
translated__content__ar__descriptionstringThe description of the article.
translated__content__ar__updated__atintegerThe time when the article was last updated (seconds).
translated__content__bg__created__atintegerThe time when the article was created (seconds).
translated__content__bg__descriptionstringThe description of the article.
translated__content__bg__updated__atintegerThe time when the article was last updated (seconds).
translated__content__bs__created__atintegerThe time when the article was created (seconds).
translated__content__bs__descriptionstringThe description of the article.
translated__content__bs__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ca__created__atintegerThe time when the article was created (seconds).
translated__content__ca__descriptionstringThe description of the article.
translated__content__ca__updated__atintegerThe time when the article was last updated (seconds).
translated__content__cs__created__atintegerThe time when the article was created (seconds).
translated__content__cs__descriptionstringThe description of the article.
translated__content__cs__updated__atintegerThe time when the article was last updated (seconds).
translated__content__da__created__atintegerThe time when the article was created (seconds).
translated__content__da__descriptionstringThe description of the article.
translated__content__da__updated__atintegerThe time when the article was last updated (seconds).
translated__content__de__created__atintegerThe time when the article was created (seconds).
translated__content__de__descriptionstringThe description of the article.
translated__content__de__updated__atintegerThe time when the article was last updated (seconds).
translated__content__el__created__atintegerThe time when the article was created (seconds).
translated__content__el__descriptionstringThe description of the article.
translated__content__el__updated__atintegerThe time when the article was last updated (seconds).
translated__content__en__created__atintegerThe time when the article was created (seconds).
translated__content__en__descriptionstringThe description of the article.
translated__content__en__updated__atintegerThe time when the article was last updated (seconds).
translated__content__es__created__atintegerThe time when the article was created (seconds).
translated__content__es__descriptionstringThe description of the article.
translated__content__es__updated__atintegerThe time when the article was last updated (seconds).
translated__content__et__created__atintegerThe time when the article was created (seconds).
translated__content__et__descriptionstringThe description of the article.
translated__content__et__updated__atintegerThe time when the article was last updated (seconds).
translated__content__fi__created__atintegerThe time when the article was created (seconds).
translated__content__fi__descriptionstringThe description of the article.
translated__content__fi__updated__atintegerThe time when the article was last updated (seconds).
translated__content__fr__created__atintegerThe time when the article was created (seconds).
translated__content__fr__descriptionstringThe description of the article.
translated__content__fr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__he__created__atintegerThe time when the article was created (seconds).
translated__content__he__descriptionstringThe description of the article.
translated__content__he__updated__atintegerThe time when the article was last updated (seconds).
translated__content__hr__created__atintegerThe time when the article was created (seconds).
translated__content__hr__descriptionstringThe description of the article.
translated__content__hr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__hu__created__atintegerThe time when the article was created (seconds).
translated__content__hu__descriptionstringThe description of the article.
translated__content__hu__updated__atintegerThe time when the article was last updated (seconds).
translated__content__id__created__atintegerThe time when the article was created (seconds).
translated__content__id__descriptionstringThe description of the article.
translated__content__id__updated__atintegerThe time when the article was last updated (seconds).
translated__content__it__created__atintegerThe time when the article was created (seconds).
translated__content__it__descriptionstringThe description of the article.
translated__content__it__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ja__created__atintegerThe time when the article was created (seconds).
translated__content__ja__descriptionstringThe description of the article.
translated__content__ja__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ko__created__atintegerThe time when the article was created (seconds).
translated__content__ko__descriptionstringThe description of the article.
translated__content__ko__updated__atintegerThe time when the article was last updated (seconds).
translated__content__lt__created__atintegerThe time when the article was created (seconds).
translated__content__lt__descriptionstringThe description of the article.
translated__content__lt__updated__atintegerThe time when the article was last updated (seconds).
translated__content__lv__created__atintegerThe time when the article was created (seconds).
translated__content__lv__descriptionstringThe description of the article.
translated__content__lv__updated__atintegerThe time when the article was last updated (seconds).
translated__content__mn__created__atintegerThe time when the article was created (seconds).
translated__content__mn__descriptionstringThe description of the article.
translated__content__mn__updated__atintegerThe time when the article was last updated (seconds).
translated__content__nb__created__atintegerThe time when the article was created (seconds).
translated__content__nb__descriptionstringThe description of the article.
translated__content__nb__updated__atintegerThe time when the article was last updated (seconds).
translated__content__nl__created__atintegerThe time when the article was created (seconds).
translated__content__nl__descriptionstringThe description of the article.
translated__content__nl__updated__atintegerThe time when the article was last updated (seconds).
translated__content__pl__created__atintegerThe time when the article was created (seconds).
translated__content__pl__descriptionstringThe description of the article.
translated__content__pl__updated__atintegerThe time when the article was last updated (seconds).
translated__content__pt__created__atintegerThe time when the article was created (seconds).
translated__content__pt__descriptionstringThe description of the article.
translated__content__pt__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ro__created__atintegerThe time when the article was created (seconds).
translated__content__ro__descriptionstringThe description of the article.
translated__content__ro__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ru__created__atintegerThe time when the article was created (seconds).
translated__content__ru__descriptionstringThe description of the article.
translated__content__ru__updated__atintegerThe time when the article was last updated (seconds).
translated__content__sl__created__atintegerThe time when the article was created (seconds).
translated__content__sl__descriptionstringThe description of the article.
translated__content__sl__updated__atintegerThe time when the article was last updated (seconds).
translated__content__sr__created__atintegerThe time when the article was created (seconds).
translated__content__sr__descriptionstringThe description of the article.
translated__content__sr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__sv__created__atintegerThe time when the article was created (seconds).
translated__content__sv__descriptionstringThe description of the article.
translated__content__sv__updated__atintegerThe time when the article was last updated (seconds).
translated__content__tr__created__atintegerThe time when the article was created (seconds).
translated__content__tr__descriptionstringThe description of the article.
translated__content__tr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__vi__created__atintegerThe time when the article was created (seconds).
translated__content__vi__descriptionstringThe description of the article.
translated__content__vi__updated__atintegerThe time when the article was last updated (seconds).
translated__content__pt__BR__author__idintegerThe ID of the author of the article.
translated__content__zh__CN__author__idintegerThe ID of the author of the article.
translated__content__zh__TW__author__idintegerThe ID of the author of the article.
translated__content__pt__BR__created__atintegerThe time when the article was created (seconds).
translated__content__pt__BR__descriptionstringThe description of the article.
translated__content__pt__BR__updated__atintegerThe time when the article was last updated (seconds).
translated__content__zh__CN__created__atintegerThe time when the article was created (seconds).
translated__content__zh__CN__descriptionstringThe description of the article.
translated__content__zh__CN__updated__atintegerThe time when the article was last updated (seconds).
translated__content__zh__TW__created__atintegerThe time when the article was created (seconds).
translated__content__zh__TW__descriptionstringThe description of the article.
translated__content__zh__TW__updated__atintegerThe time when the article was last updated (seconds).
INTERCOM_CREATE_A_NOTEYou can add a note to a single contact.4 params
You can add a note to a single contact.
Parameters* required
idintegerThe unique identifier of a given contact.
bodystringThe text of the note.
admin_idstringThe unique identifier of a given admin.
contact_idstringThe unique identifier of a given contact.
INTERCOM_CREATE_CONVERSATIONCreates a new conversation in Intercom6 params
Creates a new conversation in Intercom
Parameters* required
bodystringThe message content for the conversation
subjectstringSubject line for the conversation
from_user_idstringID of the user to create the conversation from. Either from_user_id or from_contact_id is required
message_typestringType of message: inapp, email, or facebookdefault: inapp
from_admin_idstringID of the admin creating the conversation. If not provided, uses authenticated admin
from_contact_idstringID of the contact to create the conversation from. Either from_user_id or from_contact_id is required
INTERCOM_CREATE_OR_UPDATE_A_COMPANYYou 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...9 params
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...
Parameters* required
namestringThe name of the Company
planstringThe name of the plan you have associated with the company.
sizeintegerThe number of employees in this company.
websitestringThe URL for this company"s website. Please note that the value specified here is not validated. Accepts any string.
industrystringThe industry that this company operates in.
company_idstringThe company id you have defined for the company. Can"t be updated
monthly_spendintegerHow much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647..
custom_attributesobjectA hash of key/value pairs containing any other data about the company you want Intercom to store.
remote_created_atintegerThe time the company was created by you.
INTERCOM_DELETE_A_COLLECTIONYou can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/<id>`.1 params
You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/<id>`.
Parameters* required
idintegerThe unique identifier for the collection which is given by Intercom.
INTERCOM_DELETE_A_COMPANYYou can delete a single company.1 params
You can delete a single company.
Parameters* required
idstringThe unique identifier for the company which is given by Intercom
INTERCOM_DELETE_A_CONTACTYou can delete a single contact.1 params
You can delete a single contact.
Parameters* required
idstringid
INTERCOM_DELETE_AN_ARTICLEYou can delete a single article by making a DELETE request to `https://api.intercom.io/articles/<id>`.1 params
You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/<id>`.
Parameters* required
idintegerThe unique identifier for the article which is given by Intercom.
INTERCOM_DETACH_A_CONTACT_FROM_A_COMPANYYou can detach a company from a single contact.2 params
You can detach a company from a single contact.
Parameters* required
idstringThe unique identifier for the company which is given by Intercom
contact_idstringThe unique identifier for the contact which is given by Intercom
INTERCOM_GET_A_CONTACTYou can fetch the details of a single contact.1 params
You can fetch the details of a single contact.
Parameters* required
idstringid
INTERCOM_GET_CONVERSATIONRetrieves a specific conversation by ID with all messages and details2 params
Retrieves a specific conversation by ID with all messages and details
Parameters* required
display_asstringDisplay format for message content: plaintext or html
conversation_idstringThe ID of the conversation to retrieve
INTERCOM_IDENTIFY_AN_ADMINYou 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 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,...
No parameter schema in public metadata yet.
INTERCOM_LIST_ALL_ACTIVITY_LOGSYou can get a log of activities by all admins in an app.2 params
You can get a log of activities by all admins in an app.
Parameters* required
created_at_afterstringThe start date that you request data for. It must be formatted as a UNIX timestamp.
created_at_beforestringThe end date that you request data for. It must be formatted as a UNIX timestamp.
INTERCOM_LIST_ALL_ADMINSYou can fetch a list of admins for a given workspace.
You can fetch a list of admins for a given workspace.
No parameter schema in public metadata yet.
INTERCOM_LIST_ALL_ARTICLESYou 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...
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...
No parameter schema in public metadata yet.
INTERCOM_LIST_ALL_COLLECTIONSYou 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 rece...
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 rece...
No parameter schema in public metadata yet.
INTERCOM_LIST_ALL_COMPANIESYou 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...3 params
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...
Parameters* required
pageintegerThe page of results to fetch. Defaults to first page
orderstring`asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc
per_pageintegerHow many results to return per page. Defaults to 15. Maximum allowed value is 60.default: 15
INTERCOM_LIST_ALL_HELP_CENTERSYou can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.
You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.
No parameter schema in public metadata yet.
INTERCOM_LIST_ALL_NOTESYou can fetch a list of notes that are associated to a contact.1 params
You can fetch a list of notes that are associated to a contact.
Parameters* required
idintegerThe unique identifier of a contact.
INTERCOM_LIST_ATTACHED_COMPANIES_FOR_CONTACTYou can fetch a list of companies that are associated to a contact.1 params
You can fetch a list of companies that are associated to a contact.
Parameters* required
idstringThe unique identifier for the contact which is given by Intercom
INTERCOM_LIST_ATTACHED_CONTACTSYou can fetch a list of all contacts that belong to a company.1 params
You can fetch a list of all contacts that belong to a company.
Parameters* required
idstringThe unique identifier for the company which is given by Intercom
INTERCOM_LIST_ATTACHED_SEGMENTS_FOR_COMPANIESYou can fetch a list of all segments that belong to a company.1 params
You can fetch a list of all segments that belong to a company.
Parameters* required
idstringThe unique identifier for the company which is given by Intercom
INTERCOM_LIST_ATTACHED_SEGMENTS_FOR_CONTACTYou can fetch a list of segments that are associated to a contact.1 params
You can fetch a list of segments that are associated to a contact.
Parameters* required
contact_idstringThe unique identifier for the contact which is given by Intercom
INTERCOM_LIST_CONVERSATIONSLists conversations from Intercom with filtering and pagination support5 params
Lists conversations from Intercom with filtering and pagination support
Parameters* required
statestringFilter by conversation state: open, closed, snoozed
per_pageintegerNumber of conversations per page (1-150)default: 20
display_asstringDisplay format: plaintext or html
assignee_idstringFilter by assignee admin ID
starting_afterstringPagination cursor - ID of the last conversation from previous page
INTERCOM_LIST_SUBSCRIPTIONS_FOR_A_CONTACTYou 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...1 params
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...
Parameters* required
contact_idstringThe unique identifier for the contact which is given by Intercom
INTERCOM_LIST_TAGS_ATTACHED_TO_A_CONTACTYou can fetch a list of all tags that are attached to a specific contact.1 params
You can fetch a list of all tags that are attached to a specific contact.
Parameters* required
contact_idstringThe unique identifier for the contact which is given by Intercom
INTERCOM_MERGE_A_LEAD_AND_A_USERYou can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.2 params
You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.
Parameters* required
fromstringThe unique identifier for the contact to merge away from. Must be a lead.
intostringThe unique identifier for the contact to merge into. Must be a user.
INTERCOM_REMOVE_SUBSCRIPTION_FROM_A_CONTACTYou 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.2 params
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.
Parameters* required
idstringThe unique identifier for the subscription type which is given by Intercom
contact_idstringThe unique identifier for the contact which is given by Intercom
INTERCOM_REMOVE_TAG_FROM_A_CONTACTYou can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.2 params
You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.
Parameters* required
idstringThe unique identifier for the tag which is given by Intercom
contact_idstringThe unique identifier for the contact which is given by Intercom
INTERCOM_REOPEN_CONVERSATIONReopens a closed conversation in Intercom3 params
Reopens a closed conversation in Intercom
Parameters* required
bodystringOptional message to send when reopening the conversation
admin_idstringID of the admin reopening the conversation
conversation_idstringThe ID of the conversation to reopen
INTERCOM_REPLY_TO_CONVERSATIONSends a reply to an existing conversation in Intercom5 params
Sends a reply to an existing conversation in Intercom
Parameters* required
admin_idstringID of the admin sending the reply. Required - must be explicitly provided.
message_bodystringThe message content to send as a reply
message_typestringType of message: comment, note, or assignmentdefault: comment
attachment_urlsarrayList of attachment URLs to include in the reply
conversation_idstringThe ID of the conversation to reply to
INTERCOM_RETRIEVE_A_COLLECTIONYou can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/<id>`.1 params
You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/<id>`.
Parameters* required
idintegerThe unique identifier for the collection which is given by Intercom.
INTERCOM_RETRIEVE_A_COMPANY_BY_IDYou can fetch a single company.1 params
You can fetch a single company.
Parameters* required
idstringThe unique identifier for the company which is given by Intercom
INTERCOM_RETRIEVE_A_HELP_CENTERYou can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/<id>`.1 params
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>`.
Parameters* required
idintegerThe unique identifier for the collection which is given by Intercom.
INTERCOM_RETRIEVE_AN_ADMINYou can retrieve the details of a single admin.1 params
You can retrieve the details of a single admin.
Parameters* required
idintegerThe unique identifier of a given admin
INTERCOM_RETRIEVE_AN_ARTICLEYou can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/<id>`.1 params
You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/<id>`.
Parameters* required
idintegerThe unique identifier for the article which is given by Intercom.
INTERCOM_RETRIEVE_COMPANIESYou 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://ap...6 params
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://ap...
Parameters* required
namestringThe `name` of the company to filter by.
pageintegerThe page of results to fetch. Defaults to first page
tag_idstringThe `tag_id` of the company to filter by.
per_pageintegerHow many results to display per page. Defaults to 15
company_idstringThe `company_id` of the company to filter by.
segment_idstringThe `segment_id` of the company to filter by.
INTERCOM_SCROLL_OVER_ALL_COMPANIESThe `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 op...1 params
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 op...
Parameters* required
scroll_paramstringScroll Param
INTERCOM_SEARCH_CONVERSATIONSSearches for conversations using query string with support for filtering and sorting5 params
Searches for conversations using query string with support for filtering and sorting
Parameters* required
querystringSearch query string to find conversations
per_pageintegerNumber of conversations per page (1-150)default: 20
sort_fieldstringField to sort by: created_at, updated_at, waiting_sincedefault: updated_at
sort_orderstringSort order: ascending or descendingdefault: descending
starting_afterstringPagination cursor - ID of the last conversation from previous page
INTERCOM_SEARCH_FOR_ARTICLESYou can search for articles by making a GET request to `https://api.intercom.io/articles/search`.4 params
You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.
Parameters* required
statestringThe state of the Articles returned. One of `published`, `draft` or `all`.
phrasestringThe phrase within your articles to search for.
highlightbooleanReturn a highlighted version of the matching content within your articles. Refer to the response schema for more details.
help_center_idintegerThe ID of the Help Center to search in.
INTERCOM_SET_AN_ADMIN_TO_AWAYYou can set an Admin as away for the Inbox.3 params
You can set an Admin as away for the Inbox.
Parameters* required
idintegerThe unique identifier of a given admin
away_mode_enabledbooleanSet to "true" to change the status of the admin to away.default: true
away_mode_reassignbooleanSet to "true" to assign any new conversation replies to your default inbox. default: false
INTERCOM_UPDATE_A_COLLECTIONYou can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/<id>`.116 params
You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/<id>`.
Parameters* required
idintegerThe unique identifier for the collection which is given by Intercom.
namestringThe name of the collection. For multilingual collections, this will be the name of the default language"s content.
parent_idstringThe id of the parent collection. If `null` then it will be updated as the first level collection.
descriptionstringThe description of the collection. For multilingual collections, this will be the description of the default language"s content.
translated__content__typestringThe type of object - group_translated_content.one of
None · group_translated_contenttranslated__content__ar__namestringThe name of the collection or section.
translated__content__ar__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__bg__namestringThe name of the collection or section.
translated__content__bg__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__bs__namestringThe name of the collection or section.
translated__content__bs__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__ca__namestringThe name of the collection or section.
translated__content__ca__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__cs__namestringThe name of the collection or section.
translated__content__cs__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__da__namestringThe name of the collection or section.
translated__content__da__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__de__namestringThe name of the collection or section.
translated__content__de__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__el__namestringThe name of the collection or section.
translated__content__el__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__en__namestringThe name of the collection or section.
translated__content__en__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__es__namestringThe name of the collection or section.
translated__content__es__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__et__namestringThe name of the collection or section.
translated__content__et__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__fi__namestringThe name of the collection or section.
translated__content__fi__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__fr__namestringThe name of the collection or section.
translated__content__fr__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__he__namestringThe name of the collection or section.
translated__content__he__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__hr__namestringThe name of the collection or section.
translated__content__hr__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__hu__namestringThe name of the collection or section.
translated__content__hu__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__id__namestringThe name of the collection or section.
translated__content__id__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__it__namestringThe name of the collection or section.
translated__content__it__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__ja__namestringThe name of the collection or section.
translated__content__ja__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__ko__namestringThe name of the collection or section.
translated__content__ko__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__lt__namestringThe name of the collection or section.
translated__content__lt__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__lv__namestringThe name of the collection or section.
translated__content__lv__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__mn__namestringThe name of the collection or section.
translated__content__mn__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__nb__namestringThe name of the collection or section.
translated__content__nb__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__nl__namestringThe name of the collection or section.
translated__content__nl__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__pl__namestringThe name of the collection or section.
translated__content__pl__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__pt__namestringThe name of the collection or section.
translated__content__pt__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__ro__namestringThe name of the collection or section.
translated__content__ro__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__ru__namestringThe name of the collection or section.
translated__content__ru__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__sl__namestringThe name of the collection or section.
translated__content__sl__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__sr__namestringThe name of the collection or section.
translated__content__sr__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__sv__namestringThe name of the collection or section.
translated__content__sv__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__tr__namestringThe name of the collection or section.
translated__content__tr__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__vi__namestringThe name of the collection or section.
translated__content__vi__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__pt__BR__namestringThe name of the collection or section.
translated__content__pt__BR__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__zh__CN__namestringThe name of the collection or section.
translated__content__zh__CN__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__zh__TW__namestringThe name of the collection or section.
translated__content__zh__TW__typestringThe type of object - `group_content` .one of
None · group_contenttranslated__content__ar__descriptionstringThe description of the collection. Only available for collections.
translated__content__bg__descriptionstringThe description of the collection. Only available for collections.
translated__content__bs__descriptionstringThe description of the collection. Only available for collections.
translated__content__ca__descriptionstringThe description of the collection. Only available for collections.
translated__content__cs__descriptionstringThe description of the collection. Only available for collections.
translated__content__da__descriptionstringThe description of the collection. Only available for collections.
translated__content__de__descriptionstringThe description of the collection. Only available for collections.
translated__content__el__descriptionstringThe description of the collection. Only available for collections.
translated__content__en__descriptionstringThe description of the collection. Only available for collections.
translated__content__es__descriptionstringThe description of the collection. Only available for collections.
translated__content__et__descriptionstringThe description of the collection. Only available for collections.
translated__content__fi__descriptionstringThe description of the collection. Only available for collections.
translated__content__fr__descriptionstringThe description of the collection. Only available for collections.
translated__content__he__descriptionstringThe description of the collection. Only available for collections.
translated__content__hr__descriptionstringThe description of the collection. Only available for collections.
translated__content__hu__descriptionstringThe description of the collection. Only available for collections.
translated__content__id__descriptionstringThe description of the collection. Only available for collections.
translated__content__it__descriptionstringThe description of the collection. Only available for collections.
translated__content__ja__descriptionstringThe description of the collection. Only available for collections.
translated__content__ko__descriptionstringThe description of the collection. Only available for collections.
translated__content__lt__descriptionstringThe description of the collection. Only available for collections.
translated__content__lv__descriptionstringThe description of the collection. Only available for collections.
translated__content__mn__descriptionstringThe description of the collection. Only available for collections.
translated__content__nb__descriptionstringThe description of the collection. Only available for collections.
translated__content__nl__descriptionstringThe description of the collection. Only available for collections.
translated__content__pl__descriptionstringThe description of the collection. Only available for collections.
translated__content__pt__descriptionstringThe description of the collection. Only available for collections.
translated__content__ro__descriptionstringThe description of the collection. Only available for collections.
translated__content__ru__descriptionstringThe description of the collection. Only available for collections.
translated__content__sl__descriptionstringThe description of the collection. Only available for collections.
translated__content__sr__descriptionstringThe description of the collection. Only available for collections.
translated__content__sv__descriptionstringThe description of the collection. Only available for collections.
translated__content__tr__descriptionstringThe description of the collection. Only available for collections.
translated__content__vi__descriptionstringThe description of the collection. Only available for collections.
translated__content__pt__BR__descriptionstringThe description of the collection. Only available for collections.
translated__content__zh__CN__descriptionstringThe description of the collection. Only available for collections.
translated__content__zh__TW__descriptionstringThe description of the collection. Only available for collections.
INTERCOM_UPDATE_A_COMPANYYou 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 %}1 params
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 %}
Parameters* required
idstringThe unique identifier for the company which is given by Intercom
INTERCOM_UPDATE_A_CONTACTYou can update an existing contact (ie. user or lead).1 params
You can update an existing contact (ie. user or lead).
Parameters* required
idstringid
INTERCOM_UPDATE_AN_ARTICLEYou can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/<id>`.342 params
You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/<id>`.
Parameters* required
idintegerThe unique identifier for the article which is given by Intercom.
bodystringThe content of the article. For multilingual articles, this will be the body of the default language"s content.
statestringWhether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language"s content. one of
published · drafttitlestringThe title of the article.For multilingual articles, this will be the title of the default language"s content.
author_idintegerThe id of the author of the article. For multilingual articles, this will be the id of the author of the default language"s content. Must be a teammate on the help center"s workspace.
parent_idstringThe id of the article"s parent collection or section. An article without this field stands alone.
descriptionstringThe description of the article. For multilingual articles, this will be the description of the default language"s content.
parent_typestringThe type of parent, which can either be a `collection` or `section`.
translated__content__typestringThe type of object - article_translated_content.one of
None · article_translated_contenttranslated__content__ar__urlstringThe URL of the article.
translated__content__bg__urlstringThe URL of the article.
translated__content__bs__urlstringThe URL of the article.
translated__content__ca__urlstringThe URL of the article.
translated__content__cs__urlstringThe URL of the article.
translated__content__da__urlstringThe URL of the article.
translated__content__de__urlstringThe URL of the article.
translated__content__el__urlstringThe URL of the article.
translated__content__en__urlstringThe URL of the article.
translated__content__es__urlstringThe URL of the article.
translated__content__et__urlstringThe URL of the article.
translated__content__fi__urlstringThe URL of the article.
translated__content__fr__urlstringThe URL of the article.
translated__content__he__urlstringThe URL of the article.
translated__content__hr__urlstringThe URL of the article.
translated__content__hu__urlstringThe URL of the article.
translated__content__id__urlstringThe URL of the article.
translated__content__it__urlstringThe URL of the article.
translated__content__ja__urlstringThe URL of the article.
translated__content__ko__urlstringThe URL of the article.
translated__content__lt__urlstringThe URL of the article.
translated__content__lv__urlstringThe URL of the article.
translated__content__mn__urlstringThe URL of the article.
translated__content__nb__urlstringThe URL of the article.
translated__content__nl__urlstringThe URL of the article.
translated__content__pl__urlstringThe URL of the article.
translated__content__pt__urlstringThe URL of the article.
translated__content__ro__urlstringThe URL of the article.
translated__content__ru__urlstringThe URL of the article.
translated__content__sl__urlstringThe URL of the article.
translated__content__sr__urlstringThe URL of the article.
translated__content__sv__urlstringThe URL of the article.
translated__content__tr__urlstringThe URL of the article.
translated__content__vi__urlstringThe URL of the article.
translated__content__ar__bodystringThe body of the article.
translated__content__ar__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__bg__bodystringThe body of the article.
translated__content__bg__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__bs__bodystringThe body of the article.
translated__content__bs__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__ca__bodystringThe body of the article.
translated__content__ca__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__cs__bodystringThe body of the article.
translated__content__cs__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__da__bodystringThe body of the article.
translated__content__da__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__de__bodystringThe body of the article.
translated__content__de__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__el__bodystringThe body of the article.
translated__content__el__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__en__bodystringThe body of the article.
translated__content__en__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__es__bodystringThe body of the article.
translated__content__es__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__et__bodystringThe body of the article.
translated__content__et__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__fi__bodystringThe body of the article.
translated__content__fi__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__fr__bodystringThe body of the article.
translated__content__fr__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__he__bodystringThe body of the article.
translated__content__he__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__hr__bodystringThe body of the article.
translated__content__hr__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__hu__bodystringThe body of the article.
translated__content__hu__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__id__bodystringThe body of the article.
translated__content__id__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__it__bodystringThe body of the article.
translated__content__it__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__ja__bodystringThe body of the article.
translated__content__ja__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__ko__bodystringThe body of the article.
translated__content__ko__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__lt__bodystringThe body of the article.
translated__content__lt__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__lv__bodystringThe body of the article.
translated__content__lv__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__mn__bodystringThe body of the article.
translated__content__mn__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__nb__bodystringThe body of the article.
translated__content__nb__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__nl__bodystringThe body of the article.
translated__content__nl__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__pl__bodystringThe body of the article.
translated__content__pl__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__pt__bodystringThe body of the article.
translated__content__pt__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__ro__bodystringThe body of the article.
translated__content__ro__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__ru__bodystringThe body of the article.
translated__content__ru__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__sl__bodystringThe body of the article.
translated__content__sl__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__sr__bodystringThe body of the article.
translated__content__sr__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__sv__bodystringThe body of the article.
translated__content__sv__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__tr__bodystringThe body of the article.
translated__content__tr__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__vi__bodystringThe body of the article.
translated__content__vi__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__ar__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__ar__titlestringThe title of the article.
translated__content__bg__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__bg__titlestringThe title of the article.
translated__content__bs__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__bs__titlestringThe title of the article.
translated__content__ca__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__ca__titlestringThe title of the article.
translated__content__cs__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__cs__titlestringThe title of the article.
translated__content__da__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__da__titlestringThe title of the article.
translated__content__de__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__de__titlestringThe title of the article.
translated__content__el__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__el__titlestringThe title of the article.
translated__content__en__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__en__titlestringThe title of the article.
translated__content__es__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__es__titlestringThe title of the article.
translated__content__et__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__et__titlestringThe title of the article.
translated__content__fi__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__fi__titlestringThe title of the article.
translated__content__fr__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__fr__titlestringThe title of the article.
translated__content__he__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__he__titlestringThe title of the article.
translated__content__hr__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__hr__titlestringThe title of the article.
translated__content__hu__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__hu__titlestringThe title of the article.
translated__content__id__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__id__titlestringThe title of the article.
translated__content__it__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__it__titlestringThe title of the article.
translated__content__ja__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__ja__titlestringThe title of the article.
translated__content__ko__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__ko__titlestringThe title of the article.
translated__content__lt__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__lt__titlestringThe title of the article.
translated__content__lv__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__lv__titlestringThe title of the article.
translated__content__mn__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__mn__titlestringThe title of the article.
translated__content__nb__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__nb__titlestringThe title of the article.
translated__content__nl__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__nl__titlestringThe title of the article.
translated__content__pl__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__pl__titlestringThe title of the article.
translated__content__pt__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__pt__titlestringThe title of the article.
translated__content__ro__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__ro__titlestringThe title of the article.
translated__content__ru__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__ru__titlestringThe title of the article.
translated__content__sl__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__sl__titlestringThe title of the article.
translated__content__sr__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__sr__titlestringThe title of the article.
translated__content__sv__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__sv__titlestringThe title of the article.
translated__content__tr__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__tr__titlestringThe title of the article.
translated__content__vi__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__vi__titlestringThe title of the article.
translated__content__pt__BR__urlstringThe URL of the article.
translated__content__zh__CN__urlstringThe URL of the article.
translated__content__zh__TW__urlstringThe URL of the article.
translated__content__pt__BR__bodystringThe body of the article.
translated__content__pt__BR__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__zh__CN__bodystringThe body of the article.
translated__content__zh__CN__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__zh__TW__bodystringThe body of the article.
translated__content__zh__TW__typestringThe type of object - `article_content` .one of
None · article_contenttranslated__content__pt__BR__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__pt__BR__titlestringThe title of the article.
translated__content__zh__CN__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__zh__CN__titlestringThe title of the article.
translated__content__zh__TW__statestringWhether the article is `published` or is a `draft` .one of
published · drafttranslated__content__zh__TW__titlestringThe title of the article.
translated__content__ar__author__idintegerThe ID of the author of the article.
translated__content__bg__author__idintegerThe ID of the author of the article.
translated__content__bs__author__idintegerThe ID of the author of the article.
translated__content__ca__author__idintegerThe ID of the author of the article.
translated__content__cs__author__idintegerThe ID of the author of the article.
translated__content__da__author__idintegerThe ID of the author of the article.
translated__content__de__author__idintegerThe ID of the author of the article.
translated__content__el__author__idintegerThe ID of the author of the article.
translated__content__en__author__idintegerThe ID of the author of the article.
translated__content__es__author__idintegerThe ID of the author of the article.
translated__content__et__author__idintegerThe ID of the author of the article.
translated__content__fi__author__idintegerThe ID of the author of the article.
translated__content__fr__author__idintegerThe ID of the author of the article.
translated__content__he__author__idintegerThe ID of the author of the article.
translated__content__hr__author__idintegerThe ID of the author of the article.
translated__content__hu__author__idintegerThe ID of the author of the article.
translated__content__id__author__idintegerThe ID of the author of the article.
translated__content__it__author__idintegerThe ID of the author of the article.
translated__content__ja__author__idintegerThe ID of the author of the article.
translated__content__ko__author__idintegerThe ID of the author of the article.
translated__content__lt__author__idintegerThe ID of the author of the article.
translated__content__lv__author__idintegerThe ID of the author of the article.
translated__content__mn__author__idintegerThe ID of the author of the article.
translated__content__nb__author__idintegerThe ID of the author of the article.
translated__content__nl__author__idintegerThe ID of the author of the article.
translated__content__pl__author__idintegerThe ID of the author of the article.
translated__content__pt__author__idintegerThe ID of the author of the article.
translated__content__ro__author__idintegerThe ID of the author of the article.
translated__content__ru__author__idintegerThe ID of the author of the article.
translated__content__sl__author__idintegerThe ID of the author of the article.
translated__content__sr__author__idintegerThe ID of the author of the article.
translated__content__sv__author__idintegerThe ID of the author of the article.
translated__content__tr__author__idintegerThe ID of the author of the article.
translated__content__vi__author__idintegerThe ID of the author of the article.
translated__content__ar__created__atintegerThe time when the article was created (seconds).
translated__content__ar__descriptionstringThe description of the article.
translated__content__ar__updated__atintegerThe time when the article was last updated (seconds).
translated__content__bg__created__atintegerThe time when the article was created (seconds).
translated__content__bg__descriptionstringThe description of the article.
translated__content__bg__updated__atintegerThe time when the article was last updated (seconds).
translated__content__bs__created__atintegerThe time when the article was created (seconds).
translated__content__bs__descriptionstringThe description of the article.
translated__content__bs__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ca__created__atintegerThe time when the article was created (seconds).
translated__content__ca__descriptionstringThe description of the article.
translated__content__ca__updated__atintegerThe time when the article was last updated (seconds).
translated__content__cs__created__atintegerThe time when the article was created (seconds).
translated__content__cs__descriptionstringThe description of the article.
translated__content__cs__updated__atintegerThe time when the article was last updated (seconds).
translated__content__da__created__atintegerThe time when the article was created (seconds).
translated__content__da__descriptionstringThe description of the article.
translated__content__da__updated__atintegerThe time when the article was last updated (seconds).
translated__content__de__created__atintegerThe time when the article was created (seconds).
translated__content__de__descriptionstringThe description of the article.
translated__content__de__updated__atintegerThe time when the article was last updated (seconds).
translated__content__el__created__atintegerThe time when the article was created (seconds).
translated__content__el__descriptionstringThe description of the article.
translated__content__el__updated__atintegerThe time when the article was last updated (seconds).
translated__content__en__created__atintegerThe time when the article was created (seconds).
translated__content__en__descriptionstringThe description of the article.
translated__content__en__updated__atintegerThe time when the article was last updated (seconds).
translated__content__es__created__atintegerThe time when the article was created (seconds).
translated__content__es__descriptionstringThe description of the article.
translated__content__es__updated__atintegerThe time when the article was last updated (seconds).
translated__content__et__created__atintegerThe time when the article was created (seconds).
translated__content__et__descriptionstringThe description of the article.
translated__content__et__updated__atintegerThe time when the article was last updated (seconds).
translated__content__fi__created__atintegerThe time when the article was created (seconds).
translated__content__fi__descriptionstringThe description of the article.
translated__content__fi__updated__atintegerThe time when the article was last updated (seconds).
translated__content__fr__created__atintegerThe time when the article was created (seconds).
translated__content__fr__descriptionstringThe description of the article.
translated__content__fr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__he__created__atintegerThe time when the article was created (seconds).
translated__content__he__descriptionstringThe description of the article.
translated__content__he__updated__atintegerThe time when the article was last updated (seconds).
translated__content__hr__created__atintegerThe time when the article was created (seconds).
translated__content__hr__descriptionstringThe description of the article.
translated__content__hr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__hu__created__atintegerThe time when the article was created (seconds).
translated__content__hu__descriptionstringThe description of the article.
translated__content__hu__updated__atintegerThe time when the article was last updated (seconds).
translated__content__id__created__atintegerThe time when the article was created (seconds).
translated__content__id__descriptionstringThe description of the article.
translated__content__id__updated__atintegerThe time when the article was last updated (seconds).
translated__content__it__created__atintegerThe time when the article was created (seconds).
translated__content__it__descriptionstringThe description of the article.
translated__content__it__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ja__created__atintegerThe time when the article was created (seconds).
translated__content__ja__descriptionstringThe description of the article.
translated__content__ja__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ko__created__atintegerThe time when the article was created (seconds).
translated__content__ko__descriptionstringThe description of the article.
translated__content__ko__updated__atintegerThe time when the article was last updated (seconds).
translated__content__lt__created__atintegerThe time when the article was created (seconds).
translated__content__lt__descriptionstringThe description of the article.
translated__content__lt__updated__atintegerThe time when the article was last updated (seconds).
translated__content__lv__created__atintegerThe time when the article was created (seconds).
translated__content__lv__descriptionstringThe description of the article.
translated__content__lv__updated__atintegerThe time when the article was last updated (seconds).
translated__content__mn__created__atintegerThe time when the article was created (seconds).
translated__content__mn__descriptionstringThe description of the article.
translated__content__mn__updated__atintegerThe time when the article was last updated (seconds).
translated__content__nb__created__atintegerThe time when the article was created (seconds).
translated__content__nb__descriptionstringThe description of the article.
translated__content__nb__updated__atintegerThe time when the article was last updated (seconds).
translated__content__nl__created__atintegerThe time when the article was created (seconds).
translated__content__nl__descriptionstringThe description of the article.
translated__content__nl__updated__atintegerThe time when the article was last updated (seconds).
translated__content__pl__created__atintegerThe time when the article was created (seconds).
translated__content__pl__descriptionstringThe description of the article.
translated__content__pl__updated__atintegerThe time when the article was last updated (seconds).
translated__content__pt__created__atintegerThe time when the article was created (seconds).
translated__content__pt__descriptionstringThe description of the article.
translated__content__pt__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ro__created__atintegerThe time when the article was created (seconds).
translated__content__ro__descriptionstringThe description of the article.
translated__content__ro__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ru__created__atintegerThe time when the article was created (seconds).
translated__content__ru__descriptionstringThe description of the article.
translated__content__ru__updated__atintegerThe time when the article was last updated (seconds).
translated__content__sl__created__atintegerThe time when the article was created (seconds).
translated__content__sl__descriptionstringThe description of the article.
translated__content__sl__updated__atintegerThe time when the article was last updated (seconds).
translated__content__sr__created__atintegerThe time when the article was created (seconds).
translated__content__sr__descriptionstringThe description of the article.
translated__content__sr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__sv__created__atintegerThe time when the article was created (seconds).
translated__content__sv__descriptionstringThe description of the article.
translated__content__sv__updated__atintegerThe time when the article was last updated (seconds).
translated__content__tr__created__atintegerThe time when the article was created (seconds).
translated__content__tr__descriptionstringThe description of the article.
translated__content__tr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__vi__created__atintegerThe time when the article was created (seconds).
translated__content__vi__descriptionstringThe description of the article.
translated__content__vi__updated__atintegerThe time when the article was last updated (seconds).
translated__content__pt__BR__author__idintegerThe ID of the author of the article.
translated__content__zh__CN__author__idintegerThe ID of the author of the article.
translated__content__zh__TW__author__idintegerThe ID of the author of the article.
translated__content__pt__BR__created__atintegerThe time when the article was created (seconds).
translated__content__pt__BR__descriptionstringThe description of the article.
translated__content__pt__BR__updated__atintegerThe time when the article was last updated (seconds).
translated__content__zh__CN__created__atintegerThe time when the article was created (seconds).
translated__content__zh__CN__descriptionstringThe description of the article.
translated__content__zh__CN__updated__atintegerThe time when the article was last updated (seconds).
translated__content__zh__TW__created__atintegerThe time when the article was created (seconds).
translated__content__zh__TW__descriptionstringThe description of the article.
translated__content__zh__TW__updated__atintegerThe time when the article was last updated (seconds).
mcp-intercom
Intercom MCP Pack — contacts, conversations, companies via OAuth.
Part of Pipeworx — an MCP gateway connecting AI agents to 673+ live data sources.
Tools
| Tool | Description |
|---|---|
ic_search_contacts | Search for contacts by name, email, or custom attributes. Returns contact ID, name, email, and metadata. |
ic_get_contact | Get full contact details by ID. Returns name, email, phone, attributes, tags, and conversation history. |
ic_list_conversations | List conversations with pagination. Returns conversation ID, participants, status, created date, and last message preview. |
ic_get_conversation | Get complete conversation thread by ID. Returns all messages, timestamps, participants, and metadata. |
ic_list_companies | List companies with pagination. Returns company ID, name, website, employee count, and custom attributes. |
Quick Start
Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):
{
"mcpServers": {
"intercom": {
"url": "https://gateway.pipeworx.io/intercom/mcp"
}
}
}
Or connect to the full Pipeworx gateway for access to all 673+ data sources:
{
"mcpServers": {
"pipeworx": {
"url": "https://gateway.pipeworx.io/mcp"
}
}
}
Using with ask_pipeworx
Instead of calling tools directly, you can ask questions in plain English:
ask_pipeworx({ question: "your question about Intercom data" })
The gateway picks the right tool and fills the arguments automatically.
More
License
MIT
Featured
Keep your Mac awake while Claude Code and 40+ AI agents run. Sleeps when they're idle.
One time payment $9 →Integrate web data into your AI product. One API to scrape website & brand data.
Get API Key Now →Agent, run crypto. Access onchain data & trade routes via 1inch.
Install now →On Capafy, your Skill runs online 24/7 as an agent product, and you get paid every time someone uses it.
Start earning →