> ## 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 Internal Articles: Inputs, Cost & CLI

> Search for internal articles. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=intercom_search_internal_articles:{}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                | Type     | Required | Default | Description                        |
| ------------------- | -------- | -------- | ------- | ---------------------------------- |
| `payload.folder_id` | `string` | No       |         | The ID of the folder to search in. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "You can search for internal articles by making a GET request to `https://api.intercom.io/internal_articles/search`.",
    "properties": {
      "folder_id": {
        "type": "string",
        "description": "The ID of the folder to search in."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | The results of an Internal Article search      |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "The results of an Internal Article search",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of the object - `list`.",
            "enum": [
              "list"
            ]
          },
          "total_count": {
            "type": "integer",
            "description": "The total number of Internal Articles matching the search query"
          },
          "data": {
            "type": "object",
            "description": "An object containing the results of the search.",
            "properties": {
              "internal_articles": {
                "type": "array",
                "description": "An array of Internal Article objects",
                "items": {
                  "type": "object",
                  "description": "The data returned about your internal articles when you list them.",
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "The type of object - `internal_article`.",
                      "default": "internal_article",
                      "enum": [
                        "internal_article"
                      ]
                    },
                    "id": {
                      "type": "string",
                      "description": "The unique identifier for the article which is given by Intercom."
                    },
                    "title": {
                      "type": "string",
                      "description": "The title of the article."
                    },
                    "body": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "The body of the article in HTML."
                    },
                    "owner_id": {
                      "type": "integer",
                      "description": "The id of the owner of the article."
                    },
                    "author_id": {
                      "type": "integer",
                      "description": "The id of the author of the article."
                    },
                    "created_at": {
                      "type": "integer",
                      "description": "The time when the article was created.",
                      "format": "date-time"
                    },
                    "updated_at": {
                      "type": "integer",
                      "description": "The time when the article was last updated.",
                      "format": "date-time"
                    },
                    "locale": {
                      "type": "string",
                      "description": "The default locale of the article."
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          },
          "pages": {
            "type": [
              "object",
              "null"
            ],
            "description": "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.",
            "properties": {
              "type": {
                "type": "string",
                "description": "the type of object `pages`.",
                "enum": [
                  "pages"
                ]
              },
              "page": {
                "type": "integer",
                "description": "The current page"
              },
              "next": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "per_page": {
                    "type": "integer",
                    "description": "The number of results to fetch per page."
                  },
                  "starting_after": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The cursor to use in the next request to get the next page of results."
                  }
                },
                "additionalProperties": false
              },
              "per_page": {
                "type": "integer",
                "description": "Number of results per page"
              },
              "total_pages": {
                "type": "integer",
                "description": "Total number of pages"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute intercom_search_internal_articles --payload '{}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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