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.

Example:highlight=false

Headers

Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default:"2.16"

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:2.16

curl -i -X GET \
  'https://api.intercom.io/articles/search?phrase=Getting%20started&state=published&help_center_id=123&highlight=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.16'

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

{
  "type": "list",
  "total_count": 1,
  "data": {
    "articles": [ … ],
    "highlights": []
  },
  "pages": {
    "type": "pages",
    "page": 1,
    "total_pages": 1,
    "per_page": 10
  }
}