The intercom API reference.
Intercom API (2.11)
Download OpenAPI description
Overview
URL
License
Languages
Servers
The production API server
https://api.intercom.io/
The european API server
https://api.eu.intercom.io/
The australian API server
https://api.au.intercom.io/
Article
The Articles API is a central place to gather all information and take actions on your articles. Articles can live within collections and sections, or alternatively they can stand alone.
The statistics of an article.
The type of object - article_statistics.
Default "article_statistics"
Value"article_statistics"
Example: "article_statistics"
The number of conversations started from the article.
Example: 0
The number of total reactions the article has received.
Example: 10
The percentage of happy reactions the article has received against other types of reaction.
Example: 40
The percentage of neutral reactions the article has received against other types of reaction.
Example: 40
The unique identifier for the article which is given by Intercom.
Example: "6871119"
The title of the article. For multilingual articles, this will be the title of the default language's content.
Example: "Default language title"
The description of the article. For multilingual articles, this will be the description of the default language's content.
Example: "Default language description"
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
Example: "Default language body in html"
The 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.
Example: "5017691"
Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.
Default "draft"
Enum"published""draft"
Example: "published"
The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.
Example: 1672928359
The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.
Example: 1672928610
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
Example: "http://intercom.test/help/en/articles/3-default-language"
The id of the article's parent collection or section. An article without this field stands alone.
Example: "125685"
The ids of the article's parent collections or sections. An article without this field stands alone.
Example: [18,19]
The type of parent, which can either be a collection or section.
Example: "collection"
The default locale of the help center. This field is only returned for multilingual help centers.
Example: "en"
The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.
The type of object - article_translated_content.
Value"article_translated_content"
Example: "article_translated_content"
{ "statistics": { "type": "article_statistics", "views": 10, "conversions": 0, "reactions": 10, "happy_reaction_percentage": 40, "neutral_reaction_percentage": 40, "sad_reaction_percentage": 20 }, "type": "article", "id": "6871119", "workspace_id": "hfi1bx4l", "title": "Default language title", "description": "Default language description", "body": "Default language body in html", "author_id": "5017691", "state": "published", "created_at": 1672928359, "updated_at": 1672928610, "url": "http://intercom.test/help/en/articles/3-default-language", "parent_id": "125685", "parent_ids": [ 18, 19 ], "parent_type": "collection", "default_locale": "en", "translated_content": { "type": "article_translated_content", "ar": { … }, "bg": { … }, "bs": { … }, "ca": { … }, "cs": { … }, "da": { … }, "de": { … }, "el": { … }, "en": { … }, "es": { … }, "et": { … }, "fi": { … }, "fr": { … }, "he": { … }, "hr": { … }, "hu": { … }, "id": { … }, "it": { … }, "ja": { … }, "ko": { … }, "lt": { … }, "lv": { … }, "mn": { … }, "nb": { … }, "nl": { … }, "pl": { … }, "pt": { … }, "ro": { … }, "ru": { … }, "sl": { … }, "sr": { … }, "sv": { … }, "tr": { … }, "vi": { … }, "pt-BR": { … }, "zh-CN": { … }, "zh-TW": { … } } }
Articles
The data returned about your articles when you list them.
The unique identifier for the article which is given by Intercom.
Example: "6871119"
The title of the article. For multilingual articles, this will be the title of the default language's content.
Example: "Default language title"
The description of the article. For multilingual articles, this will be the description of the default language's content.
Example: "Default language description"
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
Example: "Default language body in html"
The 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.
Example: "5017691"
Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.
Default "draft"
Enum"published""draft"
Example: "published"
The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.
Example: 1672928359
The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.
Example: 1672928610
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
Example: "http://intercom.test/help/en/articles/3-default-language"
The id of the article's parent collection or section. An article without this field stands alone.
Example: "125685"
The ids of the article's parent collections or sections. An article without this field stands alone.
Example: [18,19]
The type of parent, which can either be a collection or section.
Example: "collection"
The default locale of the help center. This field is only returned for multilingual help centers.
Example: "en"
The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.
The type of object - article_translated_content.
Value"article_translated_content"
Example: "article_translated_content"
{ "type": "article", "id": "6871119", "workspace_id": "hfi1bx4l", "title": "Default language title", "description": "Default language description", "body": "Default language body in html", "author_id": "5017691", "state": "published", "created_at": 1672928359, "updated_at": 1672928610, "url": "http://intercom.test/help/en/articles/3-default-language", "parent_id": "125685", "parent_ids": [ 18, 19 ], "parent_type": "collection", "default_locale": "en", "translated_content": { "type": "article_translated_content", "ar": { … }, "bg": { … }, "bs": { … }, "ca": { … }, "cs": { … }, "da": { … }, "de": { … }, "el": { … }, "en": { … }, "es": { … }, "et": { … }, "fi": { … }, "fr": { … }, "he": { … }, "hr": { … }, "hu": { … }, "id": { … }, "it": { … }, "ja": { … }, "ko": { … }, "lt": { … }, "lv": { … }, "mn": { … }, "nb": { … }, "nl": { … }, "pl": { … }, "pt": { … }, "ro": { … }, "ru": { … }, "sl": { … }, "sr": { … }, "sv": { … }, "tr": { … }, "vi": { … }, "pt-BR": { … }, "zh-CN": { … }, "zh-TW": { … } } }
Article Search Highlights
The highlighted results of an Article search. In the examples provided my search query is always "my query".
An Article title highlighted.
An Article description and body text highlighted.
{ "article_id": "123", "highlighted_title": [ { … } ], "highlighted_summary": [ [ … ] ] }
Request
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_atattribute. This means if you need to iterate through results then we'll show the most recently updated articles first.
Security
bearerAuth
- The production API server
https://api.intercom.io/articles
- The european API server
https://api.eu.intercom.io/articles
- The australian API server
https://api.au.intercom.io/articles
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X GET \
'https://api.intercom.io/articles?page=1&per_page=15' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'successful
Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
An array of Article objects
The unique identifier for the article which is given by Intercom.
Example: "6871119"
The id of the workspace which the article belongs to.
Example: "hfi1bx4l"
The title of the article. For multilingual articles, this will be the title of the default language's content.
Example: "Default language title"
The description of the article. For multilingual articles, this will be the description of the default language's content.
Example: "Default language description"
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
Example: "Default language body in html"
The 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.
Example: "5017691"
Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.
Default "draft"
Enum"published""draft"
Example: "published"
The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.
Example: 1672928359
The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.
Example: 1672928610
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
Example: "http://intercom.test/help/en/articles/3-default-language"
The id of the article's parent collection or section. An article without this field stands alone.
Example: "125685"
The ids of the article's parent collections or sections. An article without this field stands alone.
Example: [18,19]
The type of parent, which can either be a collection or section.
Example: "collection"
The default locale of the help center. This field is only returned for multilingual help centers.
Example: "en"
The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.
The type of object - article_translated_content.
Value"article_translated_content"
Example: "article_translated_content"
Response
application/json
{ "type": "list", "pages": { "type": "pages", "page": 1, "per_page": 25, "total_pages": 1 }, "total_count": 1, "data": [ { … } ] }
Bodyapplication/json
The title of the article.For multilingual articles, this will be the title of the default language's content.
Example: "Thanks for everything"
The description of the article. For multilingual articles, this will be the description of the default language's content.
Example: "Description of the Article"
The content of the article. For multilingual articles, this will be the body of the default language's content.
Example: "<p>This is the body in html</p>"
The 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.
Example: 1295
Whether 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.
Enum"published""draft"
Example: "draft"
The id of the article's parent collection or section. An article without this field stands alone.
Example: 18
The type of parent, which can either be a collection or section.
Example: "collection"
- The production API server
https://api.intercom.io/articles
- The european API server
https://api.eu.intercom.io/articles
- The australian API server
https://api.au.intercom.io/articles
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X POST \
https://api.intercom.io/articles \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: 2.11' \
-d '{
"title": "Thanks for everything",
"description": "Description of the Article",
"body": "Body of the Article",
"author_id": 991267407,
"state": "published",
"parent_id": 145,
"parent_type": "collection",
"translated_content": {
"fr": {
"title": "Merci pour tout",
"description": "Description de l'\''article",
"body": "Corps de l'\''article",
"author_id": 991267407,
"state": "published"
}
}
}'article created
The statistics of an article.
The type of object - article_statistics.
Default "article_statistics"
Value"article_statistics"
Example: "article_statistics"
The number of conversations started from the article.
Example: 0
The number of total reactions the article has received.
Example: 10
The percentage of happy reactions the article has received against other types of reaction.
Example: 40
The percentage of neutral reactions the article has received against other types of reaction.
Example: 40
The unique identifier for the article which is given by Intercom.
Example: "6871119"
The title of the article. For multilingual articles, this will be the title of the default language's content.
Example: "Default language title"
The description of the article. For multilingual articles, this will be the description of the default language's content.
Example: "Default language description"
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
Example: "Default language body in html"
The 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.
Example: "5017691"
Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.
Default "draft"
Enum"published""draft"
Example: "published"
The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.
Example: 1672928359
The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.
Example: 1672928610
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
Example: "http://intercom.test/help/en/articles/3-default-language"
The id of the article's parent collection or section. An article without this field stands alone.
Example: "125685"
The ids of the article's parent collections or sections. An article without this field stands alone.
Example: [18,19]
The type of parent, which can either be a collection or section.
Example: "collection"
The default locale of the help center. This field is only returned for multilingual help centers.
Example: "en"
The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.
The type of object - article_translated_content.
Value"article_translated_content"
Example: "article_translated_content"
Response
application/json
{ "id": "42", "type": "article", "workspace_id": "this_is_an_id37_that_should_be_at_least_4", "parent_id": 145, "parent_type": "collection", "parent_ids": [], "statistics": { "type": "article_statistics", "views": 0, "conversations": 0, "reactions": 0, "happy_reaction_percentage": 0, "neutral_reaction_percentage": 0, "sad_reaction_percentage": 0 }, "title": "Thanks for everything", "description": "Description of the Article", "body": "<p class=\"no-margin\">Body of the Article</p>", "author_id": 991267407, "state": "published", "created_at": 1719492710, "updated_at": 1719492710, "url": "http://help-center.test/myapp-37/en/articles/42-thanks-for-everything" }
- The production API server
https://api.intercom.io/articles/{article_id}
- The european API server
https://api.eu.intercom.io/articles/{article_id}
- The australian API server
https://api.au.intercom.io/articles/{article_id}
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X GET \
https://api.intercom.io/articles/123 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'Article found
The statistics of an article.
The type of object - article_statistics.
Default "article_statistics"
Value"article_statistics"
Example: "article_statistics"
The number of conversations started from the article.
Example: 0
The number of total reactions the article has received.
Example: 10
The percentage of happy reactions the article has received against other types of reaction.
Example: 40
The percentage of neutral reactions the article has received against other types of reaction.
Example: 40
The unique identifier for the article which is given by Intercom.
Example: "6871119"
The title of the article. For multilingual articles, this will be the title of the default language's content.
Example: "Default language title"
The description of the article. For multilingual articles, this will be the description of the default language's content.
Example: "Default language description"
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
Example: "Default language body in html"
The 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.
Example: "5017691"
Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.
Default "draft"
Enum"published""draft"
Example: "published"
The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.
Example: 1672928359
The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.
Example: 1672928610
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
Example: "http://intercom.test/help/en/articles/3-default-language"
The id of the article's parent collection or section. An article without this field stands alone.
Example: "125685"
The ids of the article's parent collections or sections. An article without this field stands alone.
Example: [18,19]
The type of parent, which can either be a collection or section.
Example: "collection"
The default locale of the help center. This field is only returned for multilingual help centers.
Example: "en"
The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.
The type of object - article_translated_content.
Value"article_translated_content"
Example: "article_translated_content"
Response
application/json
{ "id": "45", "type": "article", "workspace_id": "this_is_an_id43_that_should_be_at_least_4", "parent_id": 148, "parent_type": "collection", "parent_ids": [], "statistics": { "type": "article_statistics", "views": 0, "conversations": 0, "reactions": 0, "happy_reaction_percentage": 0, "neutral_reaction_percentage": 0, "sad_reaction_percentage": 0 }, "title": "This is the article title", "description": "", "body": "", "author_id": 991267412, "state": "published", "created_at": 1719492712, "updated_at": 1719492712, "url": "http://help-center.test/myapp-43/en/articles/45-this-is-the-article-title" }
Bodyapplication/json
The title of the article.For multilingual articles, this will be the title of the default language's content.
Example: "Thanks for everything"
The description of the article. For multilingual articles, this will be the description of the default language's content.
Example: "Description of the Article"
The content of the article. For multilingual articles, this will be the body of the default language's content.
Example: "<p>This is the body in html</p>"
The 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.
Example: 1295
Whether 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.
Enum"published""draft"
Example: "draft"
The id of the article's parent collection or section. An article without this field stands alone.
Example: "18"
The type of parent, which can either be a collection or section.
Example: "collection"
- The production API server
https://api.intercom.io/articles/{article_id}
- The european API server
https://api.eu.intercom.io/articles/{article_id}
- The australian API server
https://api.au.intercom.io/articles/{article_id}
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X PUT \
https://api.intercom.io/articles/123 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: 2.11' \
-d '{
"title": "Christmas is here!",
"body": "<p>New gifts in store for the jolly season</p>"
}'successful
The statistics of an article.
The type of object - article_statistics.
Default "article_statistics"
Value"article_statistics"
Example: "article_statistics"
The number of conversations started from the article.
Example: 0
The number of total reactions the article has received.
Example: 10
The percentage of happy reactions the article has received against other types of reaction.
Example: 40
The percentage of neutral reactions the article has received against other types of reaction.
Example: 40
The unique identifier for the article which is given by Intercom.
Example: "6871119"
The title of the article. For multilingual articles, this will be the title of the default language's content.
Example: "Default language title"
The description of the article. For multilingual articles, this will be the description of the default language's content.
Example: "Default language description"
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
Example: "Default language body in html"
The 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.
Example: "5017691"
Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.
Default "draft"
Enum"published""draft"
Example: "published"
The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.
Example: 1672928359
The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.
Example: 1672928610
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
Example: "http://intercom.test/help/en/articles/3-default-language"
The id of the article's parent collection or section. An article without this field stands alone.
Example: "125685"
The ids of the article's parent collections or sections. An article without this field stands alone.
Example: [18,19]
The type of parent, which can either be a collection or section.
Example: "collection"
The default locale of the help center. This field is only returned for multilingual help centers.
Example: "en"
The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.
The type of object - article_translated_content.
Value"article_translated_content"
Example: "article_translated_content"
Response
application/json
{ "id": "48", "type": "article", "workspace_id": "this_is_an_id49_that_should_be_at_least_4", "parent_id": 151, "parent_type": "collection", "parent_ids": [], "statistics": { "type": "article_statistics", "views": 0, "conversations": 0, "reactions": 0, "happy_reaction_percentage": 0, "neutral_reaction_percentage": 0, "sad_reaction_percentage": 0 }, "title": "Christmas is here!", "description": "", "body": "<p class=\"no-margin\">New gifts in store for the jolly season</p>", "author_id": 991267418, "state": "published", "created_at": 1719492714, "updated_at": 1719492714, "url": "http://help-center.test/myapp-49/en/articles/48-christmas-is-here" }
- The production API server
https://api.intercom.io/articles/{article_id}
- The european API server
https://api.eu.intercom.io/articles/{article_id}
- The australian API server
https://api.au.intercom.io/articles/{article_id}
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X DELETE \
https://api.intercom.io/articles/123 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'Response
application/json
{ "id": "51", "object": "article", "deleted": true }
- The production API server
https://api.intercom.io/articles/search
- The european API server
https://api.eu.intercom.io/articles/search
- The australian API server
https://api.au.intercom.io/articles/search
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X GET \
'https://api.intercom.io/articles/search?phrase=Getting+started&state=published&help_center_id=123&highlight=true' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'Response
application/json
{ "type": "list", "total_count": 1, "data": { "articles": [ … ], "highlights": [] }, "pages": { "type": "pages", "page": 1, "total_pages": 1, "per_page": 10 } }