Skip to content
Home
/
REST API Reference
/
Articles
/
Article

Intercom API (2.13)

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

AI Content

With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.

 

External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.

 

Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.

 

You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",

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.

tagsobject(Tags)

A list of tags objects associated with a conversation

{
  "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": { … }
  },
  "tags": {
    "type": "tag.list",
    "tags": [ … ]
  }
}

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.

tagsobject(Tags)

A list of tags objects associated with a conversation

{
  "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": { … }
  },
  "tags": {
    "type": "tag.list",
    "tags": [ … ]
  }
}

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.

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.13
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.13
curl -i -X GET \
  https://api.intercom.io/articles \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.13'

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.

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.13
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.13
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.13' \
  -d '{
    "title": "Thanks for everything",
    "description": "Description of the Article",
    "body": "Body of the Article",
    "author_id": 991266252,
    "state": "published",
    "parent_id": 3,
    "parent_type": "collection",
    "translated_content": {
      "fr": {
        "title": "Merci pour tout",
        "description": "Description de l'\''article",
        "body": "Corps de l'\''article",
        "author_id": 991266252,
        "state": "published"
      }
    }
  }'

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.

tagsobject(Tags)

A list of tags objects associated with a conversation

Response
application/json
{
  "id": "4",
  "type": "article",
  "workspace_id": "this_is_an_id68_that_should_be_at_least_4",
  "parent_id": 3,
  "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": 991266252,
  "state": "published",
  "created_at": 1736201425,
  "updated_at": 1736201425,
  "url": "http://help-center.test/myapp-68/en/articles/4-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
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.13
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.13
curl -i -X GET \
  https://api.intercom.io/articles/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.13'

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.

tagsobject(Tags)

A list of tags objects associated with a conversation

Response
application/json
{
  "id": "7",
  "type": "article",
  "workspace_id": "this_is_an_id74_that_should_be_at_least_4",
  "parent_id": 6,
  "parent_type": "collection",
  "parent_ids": [],
  "tags": {
    "type": "tag.list",
    "tags": [ … ]
  },
  "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": 991266257,
  "state": "published",
  "created_at": 1736201428,
  "updated_at": 1736201428,
  "url": "http://help-center.test/myapp-74/en/articles/7-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
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.13
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.13
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/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.13' \
  -d '{
    "title": "Christmas is here!",
    "body": "<p>New gifts in store for the jolly season</p>"
  }'

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

tagsobject(Tags)

A list of tags objects associated with a conversation

Response
application/json
{
  "id": "10",
  "type": "article",
  "workspace_id": "this_is_an_id80_that_should_be_at_least_4",
  "parent_id": 9,
  "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": 991266263,
  "state": "published",
  "created_at": 1736201432,
  "updated_at": 1736201433,
  "url": "http://help-center.test/myapp-80/en/articles/10-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
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.13
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.13
curl -i -X DELETE \
  https://api.intercom.io/articles/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.13'

Responses

successful

Bodyapplication/json
idstring

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

Example: "6890762"
objectstring

The type of object which was deleted. - article

Value"article"
Example: "article"
deletedboolean

Whether the article was deleted successfully or not.

Example: true
Response
application/json
{
  "id": "13",
  "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.13
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.13
curl -i -X GET \
  'https://api.intercom.io/articles/search?phrase=Getting+started&state=published&help_center_id=123&highlight=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.13'

Responses

Search successful

Bodyapplication/json
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.

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

Custom Object Instances

Everything about your Custom Object instances.

Permission Requirements

From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.

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 States

Everything about your ticket states

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