provider Articles GET /articles/search
@utdk/intercom /articles/search
Search for articles
You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.
Intercom-Version header
enum: 1.0, 1.1, 1.2, 1.3…
phrase query
The phrase within your articles to search for.
string
state query
The state of the Articles returned. One of `published`, `draft` or `all`.
string
help_center_id query
The ID of the Help Center to search in.
integer
highlight query
Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.
boolean

Try it

Authentication
Configure credentials for Intercom API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

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

The phrase within your articles to search for.

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

The ID of the Help Center to search in.

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

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import intercom from '@utdk/intercom';

await intercom.searcharticles({
  "Intercom-Version": "2.14"
})