Articles

Article Content

The Content of an Article.

typestringrequired

The type of object - article_content .

Value"article_content"

Example: "article_content"

titlestringrequired

The title of the article.

Example: "How to create a new article"

descriptionstringrequired

The description of the article.

Example: "This article will show you how to create a new article."

bodystringrequired

The body of the article.

Example: "This is the body of the article."

author_idintegerrequired

The ID of the author of the article.

Example: "5017691"

statestringrequired

Whether the article is published or is a draft .

Enum"published""draft"

Example: "draft"

created_atinteger(date-time)

The time when the article was created (seconds).

Example: 1663597223

updated_atinteger(date-time)

The time when the article was last updated (seconds).

Example: 1663597260

urlstring

The URL of the article.

Example: "http://intercom.test/help/en/articles/3-default-language"

{
  "type": "article_content",
  "title": "How to create a new article",
  "description": "This article will show you how to create a new article.",
  "body": "This is the body of the article.",
  "author_id": "5017691",
  "state": "draft",
  "created_at": 1663597223,
  "updated_at": 1663597260,
  "url": "http://intercom.test/help/en/articles/3-default-language"
}

Articles

This will return a list of articles for the App.

typestringrequired

The type of the object - list.

Value"list"

Example: "list"

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.

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.

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

Article Statistics

The statistics of an article.

typestringrequired

The type of object - article_statistics.

Default "article_statistics"

Value"article_statistics"

Example: "article_statistics"

viewsintegerrequired

The number of total views the article has received.

Example: 10

conversionsintegerrequired

The number of conversations started from the article.

Example: 0

reactionsintegerrequired

The number of total reactions the article has received.

Example: 10

happy_reaction_percentagenumber(float)required

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

Example: 40

neutral_reaction_percentagenumber(float)required

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

Example: 40

sad_reaction_percentagenumber(float)required

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

Example: 20

{
  "type": "article_statistics",
  "views": 10,
  "conversions": 0,
  "reactions": 10,
  "happy_reaction_percentage": 40,
  "neutral_reaction_percentage": 40,
  "sad_reaction_percentage": 20
}

Intercom API (2.11)

Admins

Articles

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

Article Content

Articles

Article Statistics