# List Articles — HelpDocs

> Retrieve a list of articles from your HelpDocs knowledge base. See the documentation

- Key: `helpdocs-list-articles`
- Type: Action (Read-only)
- Version: 0.0.3
- App: HelpDocs (`helpdocs`) — https://pipedream.com/apps/helpdocs.md
- This page (HTML): https://pipedream.com/apps/helpdocs/actions/list-articles
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/helpdocs/actions/list-articles/list-articles.mjs

## Description

Retrieve a list of articles from your HelpDocs knowledge base. [See the documentation](https://apidocs.helpdocs.io/article/OqvaxRMHgN-getting-articles)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `categoryId` | `string` | No | The ID of a category Options are loaded from the connected account. |
| `tag` | `string` | No | Filter articles by tag |
| `includeBody` | `boolean` | No | Include the HTML body field of each article |
| `permissionGroupId` | `string` | No | The ID of a permission group Options are loaded from the connected account. |
| `status` | `string` | No | Filter articles by status |
| `isStale` | `boolean` | No | Restrict returned articles based on whether they are set as Stale or not |
| `needsTranslation` | `boolean` | No | Restrict returned articles based on whether they are marked as Needs Translation |
| `languageCode` | `string` | No | Restrict returned articles based on language code (e.g. en, fr, etc.) |
| `updatedAtBefore` | `string` | No | Restrict returned articles based on whether they were published before a certain date. E.g. 2025-01-01 |
| `updatedAtAfter` | `string` | No | Restrict returned articles based on whether they were published after a certain date. E.g. 2025-01-01 |
| `workingCopy` | `boolean` | No | Returns the latest rather than currently published versions |
| `maxResults` | `integer` | No | The maximum number of articles to return |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "helpdocs",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "helpdocs-list-articles",
  arguments: {
    categoryId: "Category ID",
    tag: "Tag",
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "helpdocs-list-articles",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    helpdocs: { authProvisionId: "apn_xxxxxxx" },
    categoryId: "Category ID",
    tag: "Tag",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "helpdocs-list-articles",
    "configured_props": {
      "helpdocs": { "authProvisionId": "apn_xxxxxxx" },
      "categoryId": "Category ID",
      "tag": "Tag"
    }
  }'
```

---

- App: https://pipedream.com/apps/helpdocs.md · All apps: https://pipedream.com/apps