Home
/
REST API Reference
/
Models
/
Articles

Intercom API (2.10)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL https://developers.intercom.com
License MIT
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

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

Tags

Everything about tags

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

Models

Article Content

The Content of an Article.

typestring or null

The type of object - article_content .

Enumnull"article_content"
Example: "article_content"
titlestring

The title of the article.

Example: "How to create a new article"
descriptionstring

The description of the article.

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

The body of the article.

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

The ID of the author of the article.

Example: "5017691"
statestring

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.

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

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

typestring

The type of object - article_statistics.

Default "article_statistics"
Value"article_statistics"
Example: "article_statistics"
viewsinteger

The number of total views the article has received.

Example: 10
conversionsinteger

The number of conversations started from the article.

Example: 0
reactionsinteger

The number of total reactions the article has received.

Example: 10
happy_reaction_percentagenumber(float)

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

Example: 40
neutral_reaction_percentagenumber(float)

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

Example: 40
sad_reaction_percentagenumber(float)

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
}