Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

Intercom API (2.11)

The intercom API reference.

Download OpenAPI description
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/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Article

The data returned about your articles when you list them.

statisticsobject or null(Article Statistics)

The statistics of an article.

typestring

The type of object - article.

Default "article"
Value"article"
Example:

"article"

idstring

The unique identifier for the article which is given by Intercom.

Example:

"6871119"

workspace_idstring

The id of the workspace which the article belongs to.

Example:

"hfi1bx4l"

titlestring

The title of the article. For multilingual articles, this will be the title of the default language's content.

Example:

"Default language title"

descriptionstring or null

The description of the article. For multilingual articles, this will be the description of the default language's content.

Example:

"Default language description"

bodystring or null

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"

author_idinteger

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"

statestring

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"

created_atinteger(date-time)

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

updated_atinteger(date-time)

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

urlstring or null

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"

parent_idinteger or null

The id of the article's parent collection or section. An article without this field stands alone.

Example:

"125685"

parent_idsArray of integers

The ids of the article's parent collections or sections. An article without this field stands alone.

Example:

[18,19]

parent_typestring or null

The type of parent, which can either be a collection or section.

Example:

"collection"

default_localestring

The default locale of the help center. This field is only returned for multilingual help centers.

Example:

"en"

translated_contentobject or null(Article Translated Content)

The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.

{ "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.

typestring

The type of object - article.

Default "article"
Value"article"
Example:

"article"

idstring

The unique identifier for the article which is given by Intercom.

Example:

"6871119"

workspace_idstring

The id of the workspace which the article belongs to.

Example:

"hfi1bx4l"

titlestring

The title of the article. For multilingual articles, this will be the title of the default language's content.

Example:

"Default language title"

descriptionstring or null

The description of the article. For multilingual articles, this will be the description of the default language's content.

Example:

"Default language description"

bodystring or null

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"

author_idinteger

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"

statestring

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"

created_atinteger(date-time)

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

updated_atinteger(date-time)

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

urlstring or null

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"

parent_idinteger or null

The id of the article's parent collection or section. An article without this field stands alone.

Example:

"125685"

parent_idsArray of integers

The ids of the article's parent collections or sections. An article without this field stands alone.

Example:

[18,19]

parent_typestring or null

The type of parent, which can either be a collection or section.

Example:

"collection"

default_localestring

The default locale of the help center. This field is only returned for multilingual help centers.

Example:

"en"

translated_contentobject or null(Article Translated Content)

The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.

{ "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".

article_idstring

The ID of the corresponding article.

Example:

"123"

highlighted_titleArray of objects

An Article title highlighted.

highlighted_summaryArray of objects

An Article description and body text highlighted.

{ "article_id": "123", "highlighted_title": [ {} ], "highlighted_summary": [ [] ] }

Article Search Response

The results of an Article search

typestring

The type of the object - list.

Value"list"
Example:

"list"

total_countinteger

The total number of Articles matching the search query

Example:

5

dataobject

An object containing the results of the search.

pagesobject or null(Cursor based pages)

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.

{ "type": "list", "total_count": 5, "data": { "articles": [], "highlights": [] }, "pages": { "type": "pages", "page": 1, "next": {}, "per_page": 2, "total_pages": 13 } }

List all articles

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.

Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.11
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:

2.11

curl -i -X GET \
  https://api.intercom.io/articles \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.11'
Experience it firsthand in the API Explorer!

Responses

successful

Bodyapplication/json
typestring

The type of the object - list.

Value"list"
Example:

"list"

pagesobject or null(Cursor based pages)

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.

total_countinteger

A count of the total number of articles.

Example:

1

dataArray of objects(Articles)

An array of Article objects

Response
application/json
{ "type": "list", "pages": { "type": "pages", "page": 1, "per_page": 25, "total_pages": 1 }, "total_count": 1, "data": [ {} ] }

Create an article

Request

You can create a new article by making a POST request to https://api.intercom.io/articles.

Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.11
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:

2.11

Bodyapplication/json
titlestringrequired

The title of the article.For multilingual articles, this will be the title of the default language's content.

Example:

"Thanks for everything"

descriptionstring

The description of the article. For multilingual articles, this will be the description of the default language's content.

Example:

"Description of the Article"

bodystring

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>"

author_idintegerrequired

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

statestring

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"

parent_idinteger

The id of the article's parent collection or section. An article without this field stands alone.

Example:

18

parent_typestring

The type of parent, which can either be a collection or section.

Example:

"collection"

translated_contentobject or null(Article Translated Content)

The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.

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"
      }
    }
  }'
Experience it firsthand in the API Explorer!

Responses

article created

Bodyapplication/json
statisticsobject or null(Article Statistics)

The statistics of an article.

typestring

The type of object - article.

Default "article"
Value"article"
Example:

"article"

idstring

The unique identifier for the article which is given by Intercom.

Example:

"6871119"

workspace_idstring

The id of the workspace which the article belongs to.

Example:

"hfi1bx4l"

titlestring

The title of the article. For multilingual articles, this will be the title of the default language's content.

Example:

"Default language title"

descriptionstring or null

The description of the article. For multilingual articles, this will be the description of the default language's content.

Example:

"Default language description"

bodystring or null

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"

author_idinteger

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"

statestring

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"

created_atinteger(date-time)

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

updated_atinteger(date-time)

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

urlstring or null

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"

parent_idinteger or null

The id of the article's parent collection or section. An article without this field stands alone.

Example:

"125685"

parent_idsArray of integers

The ids of the article's parent collections or sections. An article without this field stands alone.

Example:

[18,19]

parent_typestring or null

The type of parent, which can either be a collection or section.

Example:

"collection"

default_localestring

The default locale of the help center. This field is only returned for multilingual help centers.

Example:

"en"

translated_contentobject or null(Article Translated Content)

The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.

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

Retrieve an article

Request

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

Path
idintegerrequired

The unique identifier for the article which is given by Intercom.

Example:

123

Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.11
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:

2.11

curl -i -X GET \
  'https://api.intercom.io/articles/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.11'
Experience it firsthand in the API Explorer!

Responses

Article found

Bodyapplication/json
statisticsobject or null(Article Statistics)

The statistics of an article.

typestring

The type of object - article.

Default "article"
Value"article"
Example:

"article"

idstring

The unique identifier for the article which is given by Intercom.

Example:

"6871119"

workspace_idstring

The id of the workspace which the article belongs to.

Example:

"hfi1bx4l"

titlestring

The title of the article. For multilingual articles, this will be the title of the default language's content.

Example:

"Default language title"

descriptionstring or null

The description of the article. For multilingual articles, this will be the description of the default language's content.

Example:

"Default language description"

bodystring or null

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"

author_idinteger

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"

statestring

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"

created_atinteger(date-time)

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

updated_atinteger(date-time)

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

urlstring or null

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"

parent_idinteger or null

The id of the article's parent collection or section. An article without this field stands alone.

Example:

"125685"

parent_idsArray of integers

The ids of the article's parent collections or sections. An article without this field stands alone.

Example:

[18,19]

parent_typestring or null

The type of parent, which can either be a collection or section.

Example:

"collection"

default_localestring

The default locale of the help center. This field is only returned for multilingual help centers.

Example:

"en"

translated_contentobject or null(Article Translated Content)

The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.

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

Update an article

Request

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

Path
idintegerrequired

The unique identifier for the article which is given by Intercom.

Example:

123

Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.11
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:

2.11

Bodyapplication/json
titlestring

The title of the article.For multilingual articles, this will be the title of the default language's content.

Example:

"Thanks for everything"

descriptionstring

The description of the article. For multilingual articles, this will be the description of the default language's content.

Example:

"Description of the Article"

bodystring

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>"

author_idinteger

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

statestring

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"

parent_idstring

The id of the article's parent collection or section. An article without this field stands alone.

Example:

"18"

parent_typestring

The type of parent, which can either be a collection or section.

Example:

"collection"

translated_contentobject or null(Article Translated Content)

The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.

curl -i -X PUT \
  'https://api.intercom.io/articles/{id}' \
  -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>"
  }'
Experience it firsthand in the API Explorer!

Responses

successful

Bodyapplication/json
statisticsobject or null(Article Statistics)

The statistics of an article.

typestring

The type of object - article.

Default "article"
Value"article"
Example:

"article"

idstring

The unique identifier for the article which is given by Intercom.

Example:

"6871119"