Home
/
REST API Reference
/
Articles
/
Search for articles

Search for articles

You can search for articles by making a GET request to https://api.intercom.io/articles/search.

SecurityHTTP: bearerAuth
Request
query Parameters
phrase
string

The phrase within your articles to search for.

Example: phrase=Getting started
state
string

The state of the Articles returned. One of published, draft or all.

Example: state=published
help_center_id
integer

The ID of the Help Center to search in.

Example: help_center_id=123
highlight
boolean

Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.

header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

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

Enum: "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" "Unstable"
Example: 2.10
get
/articles/search
Request samples
Responses
200
Search successful
Response Schema: application/json
type
string 
The type of the object - list.
 Value: "list"  
total_count
integer 
The total number of Articles matching the search query
 
object 
An object containing the results of the search.
 
object 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.
 
401
Unauthorized
Response samples
application/json
{
"type": "list",
"total_count": 1,


}