> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Intercom: Search Articles

> Search Intercom Help Center articles by phrase and state. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Search Intercom Help Center articles by phrase and state.

> [!NOTE]
>
> Tool ID: `intercom_search_articles`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_search_articles',
  {
    "phrase": "example",
    "state": "California",
    "help_center_id": 123
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_search_articles --input '{
  "phrase": "example",
  "state": "California",
  "help_center_id": 123
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "type": "list",
    "total_count": 123,
    "data": {
      "articles": [
        {
          "type": "article",
          "id": "id_123",
          "workspace_id": "workspace_123"
        }
      ],
      "highlights": [
        {
          "article_id": "article_123"
        }
      ]
    }
  }
}
```

Use `deepline describe intercom_search_articles --json` for the latest machine-readable contract.

## Input reference

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

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.phrase` | `string` | No | — | The phrase within your articles to search for. |
| `payload.state` | `string` | No | — | The state of the Articles returned. One of `published`, `draft` or `all`. |
| `payload.help_center_id` | `integer` | No | — | The ID of the Help Center to search in. |
| `payload.highlight` | `boolean` | No | — | Return a highlighted version of the matching content within your articles. Refer to the response schema for more details. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.",
    "properties": {
      "phrase": {
        "type": "string",
        "description": "The phrase within your articles to search for."
      },
      "state": {
        "type": "string",
        "description": "The state of the Articles returned. One of `published`, `draft` or `all`."
      },
      "help_center_id": {
        "type": "integer",
        "description": "The ID of the Help Center to search in."
      },
      "highlight": {
        "type": "boolean",
        "description": "Return a highlighted version of the matching content within your articles. Refer to the response schema for more details."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | The results of an Article search |
| `result.data.type` | `"list"` | No | — | The type of the object - `list`. Allowed: `list`. |
| `result.data.total_count` | `integer` | No | — | The total number of Articles matching the search query |
| `result.data.data` | `object` | No | — | An object containing the results of the search. |
| `result.data.data.articles` | `array` | No | — | An array of Article objects |
| `result.data.data.articles[].type` | `"article"` | No | `"article"` | The type of object - `article`. Allowed: `article`. |
| `result.data.data.articles[].id` | `string` | No | — | The unique identifier for the article which is given by Intercom. |
| `result.data.data.articles[].workspace_id` | `string` | No | — | The id of the workspace which the article belongs to. |
| `result.data.data.articles[].title` | `string` | No | — | The title of the article. For multilingual articles, this will be the title of the default language's content. |
| `result.data.data.articles[].description` | `string \| null` | No | — | The description of the article. For multilingual articles, this will be the description of the default language's content. |
| `result.data.data.articles[].body` | `string \| null` | No | — | The body of the article in HTML. For multilingual articles, this will be the body of the default language's content. |
| `result.data.data.articles[].author_id` | `integer` | No | — | The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace. |
| `result.data.data.articles[].state` | `"published" \| "draft"` | No | `"draft"` | Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content. Allowed: `published`, `draft`. |
| `result.data.data.articles[].created_at` | `integer` | No | — | The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds. Format: `date-time`. |
| `result.data.data.articles[].updated_at` | `integer` | No | — | The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds. Format: `date-time`. |
| `result.data.data.articles[].url` | `string \| null` | No | — | The URL of the article. For multilingual articles, this will be the URL of the default language's content. |
| `result.data.data.articles[].parent_id` | `integer \| null` | No | — | The id of the article's parent collection or section. An article without this field stands alone. |
| `result.data.data.articles[].parent_ids` | `array` | No | — | The ids of the article's parent collections or sections. An article without this field stands alone. |
| `result.data.data.articles[].parent_type` | `string \| null` | No | — | The type of parent, which can either be a `collection` or `section`. |
| `result.data.data.articles[].default_locale` | `string` | No | — | The default locale of the help center. This field is only returned for multilingual help centers. |
| `result.data.data.articles[].translated_content` | `object \| null` | No | — | The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article. |
| `result.data.data.articles[].translated_content.type` | `null \| "article_translated_content"` | No | — | The type of object - article\_translated\_content. Allowed: `null`, `article_translated_content`. |
| `result.data.data.articles[].translated_content.ar` | `object \| null` | No | — | The Content of an Article. |
| `result.data.data.articles[].translated_content.ar.type` | `null \| "article_content"` | No | — | The type of object - `article_content` . Allowed: `null`, `article_content`. |
| `result.data.data.articles[].translated_content.ar.title` | `string` | No | — | The title of the article. |
| `result.data.data.articles[].translated_content.ar.description` | `string` | No | — | The description of the article. |
| `result.data.data.articles[].translated_content.ar.body` | `string` | No | — | The body of the article. |
| `result.data.data.articles[].translated_content.ar.author_id` | `integer` | No | — | The ID of the author of the article. |
| `result.data.data.articles[].translated_content.ar.state` | `"published" \| "draft"` | No | — | Whether the article is `published` or is a `draft` . Allowed: `published`, `draft`. |
| `result.data.data.articles[].translated_content.ar.created_at` | `integer` | No | — | The time when the article was created (seconds). Format: `date-time`. |
| `result.data.data.articles[].translated_content.ar.updated_at` | `integer` | No | — | The time when the article was last updated (seconds). Format: `date-time`. |
| `result.data.data.articles[].translated_content.ar.url` | `string` | No | — | The URL of the article. |
| `result.data.data.articles[].translated_content.bg` | `object \| null` | No | — | The Content of an Article. |
| `result.data.data.articles[].translated_content.bg.type` | `null \| "article_content"` | No | — | The type of object - `article_content` . Allowed: `null`, `article_content`. |
| `result.data.data.articles[].translated_content.bg.title` | `string` | No | — | The title of the article. |
| `result.data.data.articles[].translated_content.bg.description` | `string` | No | — | The description of the article. |
| `result.data.data.articles[].translated_content.bg.body` | `string` | No | — | The body of the article. |
| `result.data.data.articles[].translated_content.bg.author_id` | `integer` | No | — | The ID of the author of the article. |
| `result.data.data.articles[].translated_content.bg.state` | `"published" \| "draft"` | No | — | Whether the article is `published` or is a `draft` . Allowed: `published`, `draft`. |
| `result.data.data.articles[].translated_content.bg.created_at` | `integer` | No | — | The time when the article was created (seconds). Format: `date-time`. |
| `result.data.data.articles[].translated_content.bg.updated_at` | `integer` | No | — | The time when the article was last updated (seconds). Format: `date-time`. |
| `result.data.data.articles[].translated_content.bg.url` | `string` | No | — | The URL of the article. |
| `result.data.data.articles[].translated_content.bs` | `object \| null` | No | — | The Content of an Article. |
| `result.data.data.articles[].translated_content.bs.type` | `null \| "article_content"` | No | — | The type of object - `article_content` . Allowed: `null`, `article_content`. |
| `result.data.data.articles[].translated_content.bs.title` | `string` | No | — | The title of the article. |
| `result.data.data.articles[].translated_content.bs.description` | `string` | No | — | The description of the article. |
| `result.data.data.articles[].translated_content.bs.body` | `string` | No | — | The body of the article. |
| `result.data.data.articles[].translated_content.bs.author_id` | `integer` | No | — | The ID of the author of the article. |
| `result.data.data.articles[].translated_content.bs.state` | `"published" \| "draft"` | No | — | Whether the article is `published` or is a `draft` . Allowed: `published`, `draft`. |
| `result.data.data.articles[].translated_content.bs.created_at` | `integer` | No | — | The time when the article was created (seconds). Format: `date-time`. |

The table shows the first 50 fields. Use the live contract below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe intercom_search_articles --json`.

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Intercom provider guide](https://deepline.com/docs/providers/intercom/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.