GET /articles/search
You can search for articles by making a GET request to https://api.intercom.io/articles/search
.
Servers
- https://api.intercom.io
- https://api.eu.intercom.io
- https://api.au.intercom.io
Request headers
Name | Type | Required | Description |
---|---|---|---|
Intercom-Version |
String | No |
Possible values:
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 |
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
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.