Articles
Search for articles
You can search for articles by making a GET request to https://api.intercom.io/articles/search.
get/articles/search
Query parameters
phrasestring
The phrase within your articles to search for.
statestring
The state of the Articles returned. One of published, draft or all.
help_center_idinteger
The ID of the Help Center to search in.
highlightboolean
Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.
Headers
Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'
Intercom API version.</br>By default, it's equal to the version set in the app package.
Example:2.14
Response
Search successful
Example response
{
"type": "list",
"total_count": 5,
"data": {
"articles": [
{
"type": "article",
"id": "6871119",
"workspace_id": "hfi1bx4l",
"title": "Default language title",
"description": "Default language description",
"body": "Default language body in html",
"state": "published",
"created_at": 1672928359,
"updated_at": 1672928610,
"url": "http://intercom.test/help/en/articles/3-default-language",
"parent_ids": [
18,
19
],
"parent_type": "collection",
"default_locale": "en",
"translated_content": {
"type": "article_translated_content",
"ar": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"bg": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"bs": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"ca": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"cs": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"da": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"de": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"el": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"en": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"es": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"et": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"fi": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"fr": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"he": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"hr": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"hu": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"id": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"it": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"ja": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"ko": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"lt": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"lv": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"mn": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"nb": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"nl": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"pl": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"pt": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"ro": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"ru": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"sl": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"sr": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"sv": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"tr": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"vi": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"pt-BR": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"zh-CN": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
},
"zh-TW": {
"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.",
"state": "draft",
"created_at": 1663597223,
"updated_at": 1663597260,
"url": "http://intercom.test/help/en/articles/3-default-language"
}
},
"tags": {
"type": "tag.list",
"tags": [
{
"type": "tag",
"id": "123456",
"name": "Test tag",
"applied_at": 1663597223,
"applied_by": {
"type": "contact",
"id": "1a2b3c"
}
}
]
}
}
],
"highlights": [
{
"article_id": "123",
"highlighted_title": [
{
"type": "The highlight is ",
"text": "my query"
}
],
"highlighted_summary": [
[
{
"type": "How to highlight ",
"text": "my query"
}
]
]
}
]
},
"pages": {
"type": "pages",
"page": 1,
"next": {
"per_page": 2,
"starting_after": "your-cursor-from-response"
},
"per_page": 2,
"total_pages": 13
}
}