Intercom API (unofficial showcase)
GET/internal_articles/search

Search internal articles

Searches internal articles and returns matching results. Use folder_id to limit results to a folder and its descendant folders; the response includes the matching article count and pagination metadata.

2 parameters
folder_idintegeroptional
The integer ID of a folder; results include articles in that folder and all its descendant folders.
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 matching internal articles, the total number of matches, and cursor-based pagination metadata.
typestringoptional
The type of the object - `list`.
Allowed:list
total_countintegeroptional
The total number of Internal 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 not authorized.

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 not authorized. Use folder_id as an integer to scope results to a folder and its descendant folders.