REST API Reference

Article Search Highlights

Intercom API (2.11)

The intercom API reference.

Download OpenAPI description

api.intercom.io.json

api.intercom.io.yaml

Overview

URL

https://developers.intercom.com

License

MIT

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(Article Statistics)required

The statistics of an article.

statistics.typestringrequired

The type of object - article_statistics.

Default "article_statistics"

Value"article_statistics"

Example: "article_statistics"

statistics.viewsintegerrequired

The number of total views the article has received.

Example: 10

statistics.conversionsintegerrequired

The number of conversations started from the article.

Example: 0

statistics.reactionsintegerrequired

The number of total reactions the article has received.

Example: 10

statistics.happy_reaction_percentagenumber(float)required

The percentage of happy reactions the article has received against other types of reaction.

Example: 40

statistics.neutral_reaction_percentagenumber(float)required

The percentage of neutral reactions the article has received against other types of reaction.

Example: 40

statistics.sad_reaction_percentagenumber(float)required

The percentage of sad reactions the article has received against other types of reaction.

Example: 20

typestring

The type of object - article.

Default "article"

Value"article"

Example: "article"

idstringrequired

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

Example: "6871119"

workspace_idstringrequired

The id of the workspace which the article belongs to.

Example: "hfi1bx4l"

titlestringrequired

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 nullrequired

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 nullrequired

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_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: "5017691"

statestringrequired

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)required

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)required

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 nullrequired

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 nullrequired

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 nullrequired

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

Example: "collection"

default_localestringrequired

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

Example: "en"

translated_contentobject(Article Translated Content)required

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

translated_content.typestring

The type of object - article_translated_content.

Value"article_translated_content"

Example: "article_translated_content"

translated_content.arobject(Article Content)

The Content of an Article.

translated_content.bgobject(Article Content)

The Content of an Article.

translated_content.bsobject(Article Content)

The Content of an Article.

translated_content.caobject(Article Content)

The Content of an Article.

translated_content.csobject(Article Content)

The Content of an Article.

translated_content.daobject(Article Content)

The Content of an Article.

translated_content.deobject(Article Content)

The Content of an Article.

translated_content.elobject(Article Content)

The Content of an Article.

translated_content.enobject(Article Content)

The Content of an Article.

translated_content.esobject(Article Content)

The Content of an Article.

translated_content.etobject(Article Content)

The Content of an Article.

translated_content.fiobject(Article Content)

The Content of an Article.

translated_content.frobject(Article Content)

The Content of an Article.

translated_content.heobject(Article Content)

The Content of an Article.

translated_content.hrobject(Article Content)

The Content of an Article.

translated_content.huobject(Article Content)

The Content of an Article.

translated_content.idobject(Article Content)

The Content of an Article.

translated_content.itobject(Article Content)

The Content of an Article.

translated_content.jaobject(Article Content)

The Content of an Article.

translated_content.koobject(Article Content)

The Content of an Article.

translated_content.ltobject(Article Content)

The Content of an Article.

translated_content.lvobject(Article Content)

The Content of an Article.

translated_content.mnobject(Article Content)

The Content of an Article.

translated_content.nbobject(Article Content)

The Content of an Article.

translated_content.nlobject(Article Content)

The Content of an Article.

translated_content.plobject(Article Content)

The Content of an Article.

translated_content.ptobject(Article Content)

The Content of an Article.

translated_content.roobject(Article Content)

The Content of an Article.

translated_content.ruobject(Article Content)

The Content of an Article.

translated_content.slobject(Article Content)

The Content of an Article.

translated_content.srobject(Article Content)

The Content of an Article.

translated_content.svobject(Article Content)

The Content of an Article.

translated_content.trobject(Article Content)

The Content of an Article.

translated_content.viobject(Article Content)

The Content of an Article.

translated_content.pt-BRobject(Article Content)

The Content of an Article.

translated_content.zh-CNobject(Article Content)

The Content of an Article.

translated_content.zh-TWobject(Article Content)

The Content of an 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"

idstringrequired

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

Example: "6871119"

workspace_idstringrequired

The id of the workspace which the article belongs to.

Example: "hfi1bx4l"

titlestringrequired

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 nullrequired

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 nullrequired

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_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: "5017691"

statestringrequired

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)required

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)required

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 nullrequired

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 nullrequired

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 nullrequired

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

Example: "collection"

default_localestringrequired

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

Example: "en"

translated_contentobject(Article Translated Content)required

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

translated_content.typestring

The type of object - article_translated_content.

Value"article_translated_content"

Example: "article_translated_content"

translated_content.arobject(Article Content)

The Content of an Article.

translated_content.bgobject(Article Content)

The Content of an Article.

translated_content.bsobject(Article Content)

The Content of an Article.

translated_content.caobject(Article Content)

The Content of an Article.

translated_content.csobject(Article Content)

The Content of an Article.

translated_content.daobject(Article Content)

The Content of an Article.

translated_content.deobject(Article Content)

The Content of an Article.

translated_content.elobject(Article Content)

The Content of an Article.

translated_content.enobject(Article Content)

The Content of an Article.

translated_content.esobject(Article Content)

The Content of an Article.

translated_content.etobject(Article Content)

The Content of an Article.

translated_content.fiobject(Article Content)

The Content of an Article.

translated_content.frobject(Article Content)

The Content of an Article.

translated_content.heobject(Article Content)

The Content of an Article.

translated_content.hrobject(Article Content)

The Content of an Article.

translated_content.huobject(Article Content)

The Content of an Article.

translated_content.idobject(Article Content)

The Content of an Article.

translated_content.itobject(Article Content)

The Content of an Article.

translated_content.jaobject(Article Content)

The Content of an Article.

translated_content.koobject(Article Content)

The Content of an Article.

translated_content.ltobject(Article Content)

The Content of an Article.

translated_content.lvobject(Article Content)

The Content of an Article.

translated_content.mnobject(Article Content)

The Content of an Article.

translated_content.nbobject(Article Content)

The Content of an Article.

translated_content.nlobject(Article Content)

The Content of an Article.

translated_content.plobject(Article Content)

The Content of an Article.

translated_content.ptobject(Article Content)

The Content of an Article.

translated_content.roobject(Article Content)

The Content of an Article.

translated_content.ruobject(Article Content)

The Content of an Article.

translated_content.slobject(Article Content)

The Content of an Article.

translated_content.srobject(Article Content)

The Content of an Article.

translated_content.svobject(Article Content)

The Content of an Article.

translated_content.trobject(Article Content)

The Content of an Article.

translated_content.viobject(Article Content)

The Content of an Article.

translated_content.pt-BRobject(Article Content)

The Content of an Article.

translated_content.zh-CNobject(Article Content)

The Content of an Article.

translated_content.zh-TWobject(Article Content)

The Content of an 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_idstringrequired

The ID of the corresponding article.

Example: "123"

highlighted_titleArray of objectsrequired

An Article title highlighted.

highlighted_title[].typestring

The type of text - highlight or plain.

Enum"highlight""plain"

Example: "The highlight is "

highlighted_title[].textstring

The text of the title.

Example: "my query"

highlighted_summaryArray of objectsrequired

An Article description and body text highlighted.

Array [

highlighted_summary[][].typestring

The type of text - highlight or plain.

Enum"highlight""plain"

Example: "How to highlight "

highlighted_summary[][].textstring

The text of the title.

Example: "my query"

]

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

Article Search Response

The results of an Article search

typestringrequired

The type of the object - list.

Value"list"

Example: "list"

total_countintegerrequired

The total number of Articles matching the search query

Example: 5

dataobjectrequired

An object containing the results of the search.

data.articlesArray of objects(Article)

An array of Article objects

data.highlightsArray of objects(Article Search Highlights)

A corresponding array of highlighted Article content

pagesobject(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.

Security

bearerAuth

Query

pageinteger

The page of results to fetch. Defaults to first page

Example: page=1

per_pageinteger

How many results to display per page. Defaults to 15

Example: per_page=15

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?page=1&per_page=15' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.11'

Responses

successful

Bodyapplication/json

typestringrequired

The type of the object - list.

Value"list"

Example: "list"

pagesobject(Cursor based pages)

total_countintegerrequired

A count of the total number of articles.

Example: 1

dataArray of objects(Articles)required

An array of Article objects

data[].typestring

The type of object - article.

Default "article"

Value"article"

Example: "article"

data[].idstringrequired

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

Example: "6871119"

data[].workspace_idstringrequired

The id of the workspace which the article belongs to.

Example: "hfi1bx4l"

data[].titlestringrequired

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

Example: "Default language title"

data[].descriptionstring or nullrequired

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

Example: "Default language description"

data[].bodystring or nullrequired

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"

data[].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: "5017691"

data[].statestringrequired

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"

data[].created_atinteger(date-time)required

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

data[].updated_atinteger(date-time)required

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

data[].urlstring or nullrequired

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"

data[].parent_idinteger or nullrequired

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

Example: "125685"

data[].parent_idsArray of integers

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

Example: [18,19]

data[].parent_typestring or nullrequired

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

Example: "collection"

data[].default_localestringrequired

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

Example: "en"

data[].translated_contentobject(Article Translated Content)required

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

data[].translated_content.typestring

The type of object - article_translated_content.

Value"article_translated_content"

Example: "article_translated_content"

data[].translated_content.arobject(Article Content)

The Content of an Article.

data[].translated_content.bgobject(Article Content)

The Content of an Article.

data[].translated_content.bsobject(Article Content)

The Content of an Article.

data[].translated_content.caobject(Article Content)

The Content of an Article.

data[].translated_content.csobject(Article Content)

The Content of an Article.

data[].translated_content.daobject(Article Content)

The Content of an Article.

data[].translated_content.deobject(Article Content)

The Content of an Article.

data[].translated_content.elobject(Article Content)

The Content of an Article.

data[].translated_content.enobject(Article Content)

The Content of an Article.

data[].translated_content.esobject(Article Content)

The Content of an Article.

data[].translated_content.etobject(Article Content)

The Content of an Article.

data[].translated_content.fiobject(Article Content)

The Content of an Article.

data[].translated_content.frobject(Article Content)

The Content of an Article.

data[].translated_content.heobject(Article Content)

The Content of an Article.

data[].translated_content.hrobject(Article Content)

The Content of an Article.

data[].translated_content.huobject(Article Content)

The Content of an Article.

data[].translated_content.idobject(Article Content)

The Content of an Article.

data[].translated_content.itobject(Article Content)

The Content of an Article.

data[].translated_content.jaobject(Article Content)

The Content of an Article.

data[].translated_content.koobject(Article Content)

The Content of an Article.

data[].translated_content.ltobject(Article Content)

The Content of an Article.

data[].translated_content.lvobject(Article Content)

The Content of an Article.

data[].translated_content.mnobject(Article Content)

The Content of an Article.

data[].translated_content.nbobject(Article Content)

The Content of an Article.

data[].translated_content.nlobject(Article Content)

The Content of an Article.

data[].translated_content.plobject(Article Content)

The Content of an Article.

data[].translated_content.ptobject(Article Content)

The Content of an Article.

data[].translated_content.roobject(Article Content)

The Content of an Article.

data[].translated_content.ruobject(Article Content)

The Content of an Article.

data[].translated_content.slobject(Article Content)

The Content of an Article.

data[].translated_content.srobject(Article Content)

The Content of an Article.

data[].translated_content.svobject(Article Content)

The Content of an Article.

data[].translated_content.trobject(Article Content)

The Content of an Article.

data[].translated_content.viobject(Article Content)

The Content of an Article.

data[].translated_content.pt-BRobject(Article Content)

The Content of an Article.

data[].translated_content.zh-CNobject(Article Content)

The Content of an Article.

data[].translated_content.zh-TWobject(Article Content)

The Content of an Article.

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.

Security

bearerAuth

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

Responses

article created

Bodyapplication/json

statisticsobject(Article Statistics)required

The statistics of an article.

statistics.typestringrequired

The type of object - article_statistics.

Default "article_statistics"

Value"article_statistics"

Example: "article_statistics"

statistics.viewsintegerrequired

The number of total views the article has received.

Example: 10

statistics.conversionsintegerrequired

The number of conversations started from the article.

Example: 0

statistics.reactionsintegerrequired

The number of total reactions the article has received.

Example: 10

statistics.happy_reaction_percentagenumber(float)required

The percentage of happy reactions the article has received against other types of reaction.

Example: 40

statistics.neutral_reaction_percentagenumber(float)required

The percentage of neutral reactions the article has received against other types of reaction.

Example: 40

statistics.sad_reaction_percentagenumber(float)required

The percentage of sad reactions the article has received against other types of reaction.

Example: 20

typestring

The type of object - article.

Default "article"

Value"article"

Example: "article"

idstringrequired

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

Example: "6871119"

workspace_idstringrequired

The id of the workspace which the article belongs to.

Example: "hfi1bx4l"

titlestringrequired

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 nullrequired

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 nullrequired

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_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: "5017691"

statestringrequired

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)required

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)required

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 nullrequired

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 nullrequired

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 nullrequired

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

Example: "collection"

default_localestringrequired

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

Example: "en"

translated_contentobject(Article Translated Content)required

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

translated_content.typestring

The type of object - article_translated_content.

Value"article_translated_content"

Example: "article_translated_content"

translated_content.arobject(Article Content)

The Content of an Article.

translated_content.bgobject(Article Content)

The Content of an Article.

translated_content.bsobject(Article Content)

The Content of an Article.

translated_content.caobject(Article Content)

The Content of an Article.

translated_content.csobject(Article Content)

The Content of an Article.

translated_content.daobject(Article Content)

The Content of an Article.

translated_content.deobject(Article Content)

The Content of an Article.

translated_content.elobject(Article Content)

The Content of an Article.

translated_content.enobject(Article Content)

The Content of an Article.

translated_content.esobject(Article Content)

The Content of an Article.

translated_content.etobject(Article Content)

The Content of an Article.

translated_content.fiobject(Article Content)

The Content of an Article.

translated_content.frobject(Article Content)

The Content of an Article.

translated_content.heobject(Article Content)

The Content of an Article.

translated_content.hrobject(Article Content)

The Content of an Article.

translated_content.huobject(Article Content)

The Content of an Article.

translated_content.idobject(Article Content)

The Content of an Article.

translated_content.itobject(Article Content)

The Content of an Article.

translated_content.jaobject(Article Content)

The Content of an Article.

translated_content.koobject(Article Content)

The Content of an Article.

translated_content.ltobject(Article Content)

The Content of an Article.

translated_content.lvobject(Article Content)

The Content of an Article.

translated_content.mnobject(Article Content)

The Content of an Article.

translated_content.nbobject(Article Content)

The Content of an Article.

translated_content.nlobject(Article Content)

The Content of an Article.

translated_content.plobject(Article Content)

The Content of an Article.

translated_content.ptobject(Article Content)

The Content of an Article.

translated_content.roobject(Article Content)

The Content of an Article.

translated_content.ruobject(Article Content)

The Content of an Article.

translated_content.slobject(Article Content)

The Content of an Article.

translated_content.srobject(Article Content)

The Content of an Article.

translated_content.svobject(Article Content)

The Content of an Article.

translated_content.trobject(Article Content)

The Content of an Article.

translated_content.viobject(Article Content)

The Content of an Article.

translated_content.pt-BRobject(Article Content)

The Content of an Article.

translated_content.zh-CNobject(Article Content)

The Content of an Article.

translated_content.zh-TWobject(Article Content)

The Content of an 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>.

Security

bearerAuth

Path

article_idstringrequired

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/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.11'

Responses

Article found

Bodyapplication/json

statisticsobject(Article Statistics)required

The statistics of an article.

statistics.typestringrequired

The type of object - article_statistics.

Default "article_statistics"

Value"article_statistics"

Example: "article_statistics"

statistics.viewsintegerrequired

The number of total views the article has received.

Example: 10

statistics.conversionsintegerrequired

The number of conversations started from the article.

Example: 0

statistics.reactionsintegerrequired

The number of total reactions the article has received.

Example: 10

statistics.happy_reaction_percentagenumber(float)required

The percentage of happy reactions the article has received against other types of reaction.

Example: 40

statistics.neutral_reaction_percentagenumber(float)required

The percentage of neutral reactions the article has received against other types of reaction.

Example: 40

statistics.sad_reaction_percentagenumber(float)required

The percentage of sad reactions the article has received against other types of reaction.

Example: 20

typestring

The type of object - article.

Default "article"

Value"article"

Example: "article"

idstringrequired

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

Example: "6871119"

workspace_idstringrequired

The id of the workspace which the article belongs to.

Example: "hfi1bx4l"

titlestringrequired

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 nullrequired

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 nullrequired

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_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: "5017691"

statestringrequired

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)required

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)required

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 nullrequired

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 nullrequired

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 nullrequired

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

Example: "collection"

default_localestringrequired

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

Example: "en"

translated_contentobject(Article Translated Content)required

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

translated_content.typestring

The type of object - article_translated_content.

Value"article_translated_content"

Example: "article_translated_content"

translated_content.arobject(Article Content)

The Content of an Article.

translated_content.bgobject(Article Content)

The Content of an Article.

translated_content.bsobject(Article Content)

The Content of an Article.

translated_content.caobject(Article Content)

The Content of an Article.

translated_content.csobject(Article Content)

The Content of an Article.

translated_content.daobject(Article Content)

The Content of an Article.

translated_content.deobject(Article Content)

The Content of an Article.

translated_content.elobject(Article Content)

The Content of an Article.

translated_content.enobject(Article Content)

The Content of an Article.

translated_content.esobject(Article Content)

The Content of an Article.

translated_content.etobject(Article Content)

The Content of an Article.

translated_content.fiobject(Article Content)

The Content of an Article.

translated_content.frobject(Article Content)

The Content of an Article.

translated_content.heobject(Article Content)

The Content of an Article.

translated_content.hrobject(Article Content)

The Content of an Article.

translated_content.huobject(Article Content)

The Content of an Article.

translated_content.idobject(Article Content)

The Content of an Article.

translated_content.itobject(Article Content)

The Content of an Article.

translated_content.jaobject(Article Content)

The Content of an Article.

translated_content.koobject(Article Content)

The Content of an Article.

translated_content.ltobject(Article Content)

The Content of an Article.

translated_content.lvobject(Article Content)

The Content of an Article.

translated_content.mnobject(Article Content)

The Content of an Article.

translated_content.nbobject(Article Content)

The Content of an Article.

translated_content.nlobject(Article Content)

The Content of an Article.

translated_content.plobject(Article Content)

The Content of an Article.

translated_content.ptobject(Article Content)

The Content of an Article.

translated_content.roobject(Article Content)

The Content of an Article.

translated_content.ruobject(Article Content)

The Content of an Article.

translated_content.slobject(Article Content)

The Content of an Article.

translated_content.srobject(Article Content)

The Content of an Article.

translated_content.svobject(Article Content)

The Content of an Article.

translated_content.trobject(Article Content)

The Content of an Article.

translated_content.viobject(Article Content)

The Content of an Article.

translated_content.pt-BRobject(Article Content)

The Content of an Article.

translated_content.zh-CNobject(Article Content)

The Content of an Article.

translated_content.zh-TWobject(Article Content)

The Content of an 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>.

Security

bearerAuth

Path

article_idstringrequired

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(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/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>"
  }'

Responses

successful

Bodyapplication/json

statisticsobject(Article Statistics)required

The statistics of an article.

statistics.typestringrequired

The type of object - article_statistics.

Default "article_statistics"

Value"article_statistics"

Example: "article_statistics"

statistics.viewsintegerrequired

The number of total views the article has received.

Example: 10

statistics.conversionsintegerrequired

The number of conversations started from the article.

Example: 0

statistics.reactionsintegerrequired

The number of total reactions the article has received.

Example: 10

statistics.happy_reaction_percentagenumber(float)required

The percentage of happy reactions the article has received against other types of reaction.

Example: 40

statistics.neutral_reaction_percentagenumber(float)required

The percentage of neutral reactions the article has received against other types of reaction.

Example: 40

statistics.sad_reaction_percentagenumber(float)required

The percentage of sad reactions the article has received against other types of reaction.

Example: 20

typestring

The type of object - article.

Default "article"

Value"article"

Example: "article"

idstringrequired

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

Example: "6871119"

workspace_idstringrequired

The id of the workspace which the article belongs to.

Example: "hfi1bx4l"

titlestringrequired

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 nullrequired

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 nullrequired

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_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: "5017691"

statestringrequired

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)required

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)required

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 nullrequired

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 nullrequired

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 nullrequired

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

Example: "collection"

default_localestringrequired

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

Example: "en"

translated_contentobject(Article Translated Content)required

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

translated_content.typestring

The type of object - article_translated_content.

Value"article_translated_content"

Example: "article_translated_content"

translated_content.arobject(Article Content)

The Content of an Article.

translated_content.bgobject(Article Content)

The Content of an Article.

translated_content.bsobject(Article Content)

The Content of an Article.

translated_content.caobject(Article Content)

The Content of an Article.

translated_content.csobject(Article Content)

The Content of an Article.

translated_content.daobject(Article Content)

The Content of an Article.

translated_content.deobject(Article Content)

The Content of an Article.

translated_content.elobject(Article Content)

The Content of an Article.

translated_content.enobject(Article Content)

The Content of an Article.

translated_content.esobject(Article Content)

The Content of an Article.

translated_content.etobject(Article Content)

The Content of an Article.

translated_content.fiobject(Article Content)

The Content of an Article.

translated_content.frobject(Article Content)

The Content of an Article.

translated_content.heobject(Article Content)

The Content of an Article.

translated_content.hrobject(Article Content)

The Content of an Article.

translated_content.huobject(Article Content)

The Content of an Article.

translated_content.idobject(Article Content)

The Content of an Article.

translated_content.itobject(Article Content)

The Content of an Article.

translated_content.jaobject(Article Content)

The Content of an Article.

translated_content.koobject(Article Content)

The Content of an Article.

translated_content.ltobject(Article Content)

The Content of an Article.

translated_content.lvobject(Article Content)

The Content of an Article.

translated_content.mnobject(Article Content)

The Content of an Article.

translated_content.nbobject(Article Content)

The Content of an Article.

translated_content.nlobject(Article Content)

The Content of an Article.

translated_content.plobject(Article Content)

The Content of an Article.

translated_content.ptobject(Article Content)

The Content of an Article.

translated_content.roobject(Article Content)

The Content of an Article.

translated_content.ruobject(Article Content)

The Content of an Article.

translated_content.slobject(Article Content)

The Content of an Article.

translated_content.srobject(Article Content)

The Content of an Article.

translated_content.svobject(Article Content)

The Content of an Article.

translated_content.trobject(Article Content)

The Content of an Article.

translated_content.viobject(Article Content)

The Content of an Article.

translated_content.pt-BRobject(Article Content)

The Content of an Article.

translated_content.zh-CNobject(Article Content)

The Content of an Article.

translated_content.zh-TWobject(Article Content)

The Content of an Article.

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

Delete an article

Request

You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>.

Security

bearerAuth

Path

article_idstringrequired

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 DELETE \
  https://api.intercom.io/articles/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.11'

Responses

successful

Bodyapplication/json

idstringrequired

The unique identifier for the article which you provided in the URL.

Example: "6890762"

objectstringrequired

The type of object which was deleted. - article

Value"article"

Example: "article"

deletedbooleanrequired

Whether the article was deleted successfully or not.

Example: true

Response

application/json

{
  "id": "51",
  "object": "article",
  "deleted": true
}

Search for articles

Request

You can search for articles by making a GET request to https://api.intercom.io/articles/search.

Security

bearerAuth

Query

phrasestring

The phrase within your articles to search for.

Example: phrase=Getting started

statestring

The state of the Articles returned. One of published, draft or all.

Example: state=published

help_center_idinteger

The ID of the Help Center to search in.

Example: help_center_id=123

highlightboolean

Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.

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/search?help_center_id=123&highlight=true&phrase=Getting%20started&state=published' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.11'

Responses

Search successful

Bodyapplication/json

typestringrequired

The type of the object - list.

Value"list"

Example: "list"

total_countintegerrequired

The total number of Articles matching the search query

Example: 5

dataobjectrequired

An object containing the results of the search.

data.articlesArray of objects(Article)

An array of Article objects

data.highlightsArray of objects(Article Search Highlights)

A corresponding array of highlighted Article content

pagesobject(Cursor based pages)

Response

application/json

{
  "type": "list",
  "total_count": 1,
  "data": {
    "articles": [ … ],
    "highlights": []
  },
  "pages": {
    "type": "pages",
    "page": 1,
    "total_pages": 1,
    "per_page": 10
  }
}

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Intercom API (2.11)

Admins

Articles

Article

Articles

Article Search Highlights

Article Search Response

List all articles

Request

Responses

Was this page helpful?

Create an article

RequestExpand all

Responses

Was this page helpful?

Retrieve an article

Request

Responses

Was this page helpful?

Update an article

RequestExpand all

Responses

Was this page helpful?

Delete an article

Request

Responses

Was this page helpful?

Search for articles

Request

Responses

Was this page helpful?

Companies

Contacts

Conversations

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models

Request

Request