The intercom API reference.
Intercom API (2.9)
https://api.intercom.io/
https://api.eu.intercom.io/
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 title of the article. For multilingual articles, this will be the title of the default language's content.
The description of the article. For multilingual articles, this will be the description of the default language's content.
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
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.
Whether the article is published
or is a draft
. For multilingual articles, this will be the state of the default language's content.
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.
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.
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
The id of the article's parent collection or section. An article without this field stands alone.
The ids of the article's parent collections or sections. An article without this field stands alone.
The type of parent, which can either be a collection
or section
.
The default locale of the help center. This field is only returned for multilingual help centers.
{ "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 title of the article. For multilingual articles, this will be the title of the default language's content.
The description of the article. For multilingual articles, this will be the description of the default language's content.
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
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.
Whether the article is published
or is a draft
. For multilingual articles, this will be the state of the default language's content.
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.
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.
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
The id of the article's parent collection or section. An article without this field stands alone.
The ids of the article's parent collections or sections. An article without this field stands alone.
The type of parent, which can either be a collection
or section
.
The default locale of the help center. This field is only returned for multilingual help centers.
{ "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": { … } } }
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_at
attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.
- 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 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.9'
{ "type": "list", "pages": { "type": "pages", "page": 1, "per_page": 25, "total_pages": 1 }, "total_count": 1, "data": [ { … } ] }
The title of the article.For multilingual articles, this will be the title of the default language's content.
The description of the article. For multilingual articles, this will be the description of the default language's content.
The content of the article. For multilingual articles, this will be the body of the default language's content.
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.
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.
The id of the article's parent collection or section. An article without this field stands alone.
The type of parent, which can either be a collection
or section
.
- 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.9' \
-d '{
"title": "Thanks for everything",
"description": "Description of the Article",
"body": "Body of the Article",
"author_id": 991267259,
"state": "published",
"parent_id": 147,
"parent_type": "collection",
"translated_content": {
"fr": {
"title": "Merci pour tout",
"description": "Description de l'\''article",
"body": "Corps de l'\''article",
"author_id": 991267259,
"state": "published"
}
}
}'
article created
The title of the article. For multilingual articles, this will be the title of the default language's content.
The description of the article. For multilingual articles, this will be the description of the default language's content.
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
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.
Whether the article is published
or is a draft
. For multilingual articles, this will be the state of the default language's content.
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.
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.
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
The id of the article's parent collection or section. An article without this field stands alone.
The ids of the article's parent collections or sections. An article without this field stands alone.
The type of parent, which can either be a collection
or section
.
The default locale of the help center. This field is only returned for multilingual help centers.
{ "id": "38", "type": "article", "workspace_id": "this_is_an_id37_that_should_be_at_least_4", "parent_id": 147, "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": 991267259, "state": "published", "created_at": 1717021342, "updated_at": 1717021342, "url": "http://help-center.test/myapp-37/en/articles/38-thanks-for-everything" }
- The production API server
https://api.intercom.io/articles/{id}
- The european API server
https://api.eu.intercom.io/articles/{id}
- The australian API server
https://api.au.intercom.io/articles/{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.9'
Article found
The title of the article. For multilingual articles, this will be the title of the default language's content.
The description of the article. For multilingual articles, this will be the description of the default language's content.
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
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.
Whether the article is published
or is a draft
. For multilingual articles, this will be the state of the default language's content.
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.
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.
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
The id of the article's parent collection or section. An article without this field stands alone.
The ids of the article's parent collections or sections. An article without this field stands alone.
The type of parent, which can either be a collection
or section
.
The default locale of the help center. This field is only returned for multilingual help centers.
{ "id": "41", "type": "article", "workspace_id": "this_is_an_id43_that_should_be_at_least_4", "parent_id": 150, "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": 991267264, "state": "published", "created_at": 1717021344, "updated_at": 1717021344, "url": "http://help-center.test/myapp-43/en/articles/41-this-is-the-article-title" }
The title of the article.For multilingual articles, this will be the title of the default language's content.
The description of the article. For multilingual articles, this will be the description of the default language's content.
The content of the article. For multilingual articles, this will be the body of the default language's content.
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.
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.
The id of the article's parent collection or section. An article without this field stands alone.
The type of parent, which can either be a collection
or section
.
- The production API server
https://api.intercom.io/articles/{id}
- The european API server
https://api.eu.intercom.io/articles/{id}
- The australian API server
https://api.au.intercom.io/articles/{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.9' \
-d '{
"title": "Christmas is here!",
"body": "<p>New gifts in store for the jolly season</p>"
}'
successful
The title of the article. For multilingual articles, this will be the title of the default language's content.
The description of the article. For multilingual articles, this will be the description of the default language's content.
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
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.
Whether the article is published
or is a draft
. For multilingual articles, this will be the state of the default language's content.
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.
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.
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
The id of the article's parent collection or section. An article without this field stands alone.
The ids of the article's parent collections or sections. An article without this field stands alone.
The type of parent, which can either be a collection
or section
.
The default locale of the help center. This field is only returned for multilingual help centers.
{ "id": "44", "type": "article", "workspace_id": "this_is_an_id49_that_should_be_at_least_4", "parent_id": 153, "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": 991267270, "state": "published", "created_at": 1717021347, "updated_at": 1717021347, "url": "http://help-center.test/myapp-49/en/articles/44-christmas-is-here" }
- The production API server
https://api.intercom.io/articles/{id}
- The european API server
https://api.eu.intercom.io/articles/{id}
- The australian API server
https://api.au.intercom.io/articles/{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.9'
{ "id": "47", "object": "article", "deleted": true }