GET /articles/search

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

Servers

Request headers

Name Type Required Description
Intercom-Version String No

Possible values:

  • "1.1"
  • "2.0"
  • "1.0"
  • "2.9"
  • "Unstable"
  • "1.3"
  • "2.2"
  • "2.12"
  • "1.2"
  • "2.1"
  • "2.4"
  • "1.4"
  • "2.3"
  • "2.6"
  • "2.5"
  • "2.8"
  • "2.10"
  • "2.7"
  • "2.11"

Default value: "2.12"

Query parameters

Name Type Required Description
help_center_id Integer No

The ID of the Help Center to search in.

phrase String No

The phrase within your articles to search for.

state String No

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

highlight Boolean No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.