--- title: "Search for articles" method: GET path: "/articles/search" tags: ["Articles"] --- # Search for articles `GET /articles/search` You can search for articles by making a GET request to `https://api.intercom.io/articles/search`. ## Query parameters - `phrase` string - `state` string - `help_center_id` integer - `highlight` boolean ## 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.
By default, it's equal to the version set in the app package. ## Response `200` Search successful - ArticleSearchResponse — The results of an Article search - `type` 'list' — The type of the object - `list`. - `total_count` integer — The total number of Articles matching the search query - `data` object — An object containing the results of the search. - `articles` Article[] — An array of Article objects - `type` 'article' — The type of object - `article`. - `id` string — The unique identifier for the article which is given by Intercom. - `workspace_id` string — The id of the workspace which the article belongs to. - `title` string — The title of the article. For multilingual articles, this will be the title of the default language's content. - `description` string, nullable — The description of the article. For multilingual articles, this will be the description of the default language's content. - `body` string, nullable — The body of the article in HTML. For multilingual articles, this will be the body of the default language's content. - `author_id` integer — 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. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content. - `created_at` integer — 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. - `updated_at` integer — 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. - `url` string, nullable — The URL of the article. For multilingual articles, this will be the URL of the default language's content. - `parent_id` integer, nullable — The id of the article's parent collection or section. An article without this field stands alone. - `parent_ids` integer[] — The ids of the article's parent collections or sections. An article without this field stands alone. - `parent_type` string, nullable — The type of parent, which can either be a `collection` or `section`. - `default_locale` string — The default locale of the help center. This field is only returned for multilingual help centers. - `translated_content` ArticleTranslatedContent, nullable — The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article. - `type` 'null' | 'article_translated_content', nullable — The type of object - article_translated_content. - `ar` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `bg` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `bs` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `ca` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `cs` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `da` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `de` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `el` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `en` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `es` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `et` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `fi` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `fr` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `he` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `hr` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `hu` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `id` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `it` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `ja` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `ko` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `lt` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `lv` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `mn` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `nb` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `nl` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `pl` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `pt` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `ro` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `ru` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `sl` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `sr` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `sv` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `tr` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `vi` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `pt-BR` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `zh-CN` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `zh-TW` ArticleContent, nullable — The Content of an Article. - `type` 'null' | 'article_content', nullable — The type of object - `article_content` . - `title` string — The title of the article. - `description` string — The description of the article. - `body` string — The body of the article. - `author_id` integer — The ID of the author of the article. - `state` 'published' | 'draft' — Whether the article is `published` or is a `draft` . - `created_at` integer — The time when the article was created (seconds). - `updated_at` integer — The time when the article was last updated (seconds). - `url` string — The URL of the article. - `tags` Tags — A list of tags objects associated with a conversation - `type` 'tag.list' — The type of the object - `tags` Tag[] — A list of tags objects associated with the conversation. - `type` string — value is "tag" - `id` string — The id of the tag - `name` string — The name of the tag - `applied_at` integer, nullable — The time when the tag was applied to the object. Only present when the tag is returned as part of a tagging operation on a contact, conversation, or ticket. - `applied_by` Reference — reference to another object - `type` string - `id` string, nullable - `highlights` ArticleSearchHighlights[] — A corresponding array of highlighted Article content - `article_id` string — The ID of the corresponding article. - `highlighted_title` object[] — An Article title highlighted. - `type` 'highlight' | 'plain' — The type of text - `highlight` or `plain`. - `text` string — The text of the title. - `highlighted_summary` array[] — An Article description and body text highlighted. - object[] — An array containing the highlighted summary text split into chunks of plain and highlighted text. - `type` 'highlight' | 'plain' — The type of text - `highlight` or `plain`. - `text` string — The text of the title. - `pages` CursorPages, nullable — 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` 'pages' — the type of object `pages`. - `page` integer — The current page - `next` StartingAfterPaging, nullable - `per_page` integer — The number of results to fetch per page. - `starting_after` string, nullable — The cursor to use in the next request to get the next page of results. - `per_page` integer — Number of results per page - `total_pages` integer — Total number of pages ## Other responses - `401` — Unauthorized --- [API](https://skmtc.net/intercom/apis/intercom-api.md) · [All operations](https://skmtc.net/intercom/apis/intercom-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/intercom/intercom-api/revisions/9517e80f2642/schema)