> ## 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: List Internal Articles

> List the internal knowledge articles in Intercom. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the internal knowledge articles in Intercom.

> [!NOTE]
>
> Tool ID: `intercom_list_internal_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_list_internal_articles',
  {},
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_list_internal_articles --input '{}' --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",
    "pages": {
      "type": "pages",
      "page": 123,
      "next": {
        "per_page": 123,
        "starting_after": "cursor_123"
      }
    },
    "total_count": 123
  }
}
```

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

## Input reference

You can fetch a list of all internal articles by making a GET request to `https://api.intercom.io/internal_articles`.

This action requires no input fields.

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can fetch a list of all internal articles by making a GET request to `https://api.intercom.io/internal_articles`.",
    "properties": {},
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | This will return a list of internal articles for the App. |
| `result.data.type` | `"list"` | No | — | The type of the object - `list`. Allowed: `list`. |
| `result.data.pages` | `object \| null` | No | — | 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. |
| `result.data.pages.type` | `"pages"` | No | — | the type of object `pages`. Allowed: `pages`. |
| `result.data.pages.page` | `integer` | No | — | The current page |
| `result.data.pages.next` | `object \| null` | No | — | — |
| `result.data.pages.next.per_page` | `integer` | No | — | The number of results to fetch per page. |
| `result.data.pages.next.starting_after` | `string \| null` | No | — | The cursor to use in the next request to get the next page of results. |
| `result.data.pages.per_page` | `integer` | No | — | Number of results per page |
| `result.data.pages.total_pages` | `integer` | No | — | Total number of pages |
| `result.data.total_count` | `integer` | No | — | A count of the total number of internal articles. |
| `result.data.data` | `array` | No | — | An array of Internal Article objects |
| `result.data.data[].type` | `"internal_article"` | No | `"internal_article"` | The type of object - `internal_article`. Allowed: `internal_article`. |
| `result.data.data[].id` | `string` | No | — | The unique identifier for the article which is given by Intercom. |
| `result.data.data[].title` | `string` | No | — | The title of the article. |
| `result.data.data[].body` | `string \| null` | No | — | The body of the article in HTML. |
| `result.data.data[].owner_id` | `integer` | No | — | The id of the owner of the article. |
| `result.data.data[].author_id` | `integer` | No | — | The id of the author of the article. |
| `result.data.data[].created_at` | `integer` | No | — | The time when the article was created. Format: `date-time`. |
| `result.data.data[].updated_at` | `integer` | No | — | The time when the article was last updated. Format: `date-time`. |
| `result.data.data[].locale` | `string` | No | — | The default locale of the article. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "This will return a list of internal articles for the App.",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of the object - `list`.",
            "enum": [
              "list"
            ]
          },
          "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
          },
          "total_count": {
            "type": "integer",
            "description": "A count of the total number of internal articles."
          },
          "data": {
            "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
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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.