Intercom API (unofficial showcase)
GET/articles/search

Search for articles

Searches articles by phrase and can filter results by article state and Help Center. Use highlight to request highlighted matching content; results include article data, optional highlights, and cursor-based page information.

5 parameters
phrasestringoptional
The phrase to search for within article content.
statestringoptional
Filter results by article state: `published`, `draft`, or `all`.
help_center_idintegeroptional
The identifier of the Help Center to search.
highlightbooleanoptional
Whether to include highlighted versions of matching article content.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

2 status codes
200Returns the total number of matching articles, article results, optional highlights, and cursor-based pagination details.
typestringoptional
The type of the object - `list`.
Allowed:list
total_countintegeroptional
The total number of Articles matching the search query
dataobjectoptional
An object containing the results of the search.
pagesobjectoptional
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.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. If supplied, state must be published, draft, or all; use phrase to specify the text to search for.