Intercom API (unofficial showcase)
GET/content/search

Search Knowledge Hub content

Searches Knowledge Hub content, including articles, snippets, external pages, uploaded files, and internal articles. Supply query to search titles and body text, or omit it to retrieve the most recent content items; use the filters to narrow the results. Use page and per_page to paginate the results.

21 parameters
querystringoptional
Free-text search term matched against content titles and bodies, up to 500 characters. When omitted, the search returns the most recent content items.
pageintegeroptional
Page number to retrieve. Defaults to 1 when omitted; values below 1 are clamped to 1.
Default:1
per_pageintegeroptional
Number of results per page, from 1 to 50. Defaults to 10 when omitted.
Default:10
statesarray<string>optional
Filter by publication state using published or draft; accepts a comma-separated list or repeated parameters.
localesarray<string>optional
Filter by locale codes such as en, fr, or de; accepts a comma-separated list or repeated parameters.
tag_idsarray<integer>optional
Filter by tag IDs; pair with `tag_operator` to control matching. Accepts a comma-separated list or repeated parameters.
tag_operatorstringoptional
Match operator for `tag_ids`: IN includes items matching any supplied tag, and NIN excludes items matching any supplied tag.
Allowed:INNIN
any_tag_idsarray<integer>optional
Filter for content matching any of the supplied tag IDs; accepts a comma-separated list or repeated parameters.
folder_idsarray<integer>optional
Filter by folder IDs. Provide `folder_entity_type` with this parameter; accepts a comma-separated list or repeated parameters.
folder_entity_typestringoptional
Entity type for `folder_ids`; the accepted value is folder.
Allowed:folder
content_typesarray<string>optional
Restrict results to snippet, external_content, file_source_content, internal_article, or article. When provided, this replaces the default content type set.
copilot_statestringoptional
Filter by Copilot availability: on or off.
Allowed:onoff
fin_service_statestringoptional
Filter by Fin AI Agent availability: on or off.
Allowed:onoff
fin_sales_statestringoptional
Filter by Fin Sales Agent availability: on or off.
Allowed:onoff
created_by_idsarray<integer>optional
Filter by the IDs of the admins who created the content; accepts a comma-separated list or repeated parameters.
last_updated_by_idsarray<integer>optional
Filter by the IDs of the admins who last updated the content; accepts a comma-separated list or repeated parameters.
created_at_afterintegeroptional
Return content created at or after this Unix epoch time in seconds.
created_at_beforeintegeroptional
Return content created at or before this Unix epoch time in seconds.
updated_at_afterintegeroptional
Return content last updated at or after this Unix epoch time in seconds.
updated_at_beforeintegeroptional
Return content last updated at or before this Unix epoch time in seconds.
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

3 status codes
200Returns a paginated list of matching content items, with the total result count, page metadata, and result shapes determined by each item's type.
typestringoptional
Always `list`.
Allowed:list
total_countintegeroptional
Total number of results matching the query.
pagesobjectoptional
Pagination metadata, including links to neighbouring pages.
dataarray<ContentSearchResult>optional
The list of matched content items. Each item's `type` field determines its shape.
401Returned when the request is unauthenticated.

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
422Returned when a query parameter fails validation.

One documented failure

  • data_invalid

    Invalid or duplicated record reference

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 unauthenticated. A 422 is returned when a query parameter fails validation. page must be at least 1, per_page must be between 1 and 50, and query must not exceed 500 characters. states, tag_operator, folder_entity_type, content_types, and the availability state filters must use their documented values; provide folder_entity_type when using folder_ids.