View as Markdown
HelpDocs icon

HelpDocs ACTION

List Articles

Retrieve a list of articles from your HelpDocs knowledge base. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's HelpDocs account once, then configure and run List Articles from your backend or agent.

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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Articles inputs
Property Type Description
categoryId Category ID string
The ID of a category
Optional Dynamic
tag Tag string
Filter articles by tag
Optional
includeBody Include Body boolean
Include the HTML body field of each article
Optional
permissionGroupId Group ID string
The ID of a permission group
Optional Dynamic
status Status string
Filter articles by status
Optional
isStale Is Stale boolean
Restrict returned articles based on whether they are set as Stale or not
Optional
needsTranslation Needs Translation boolean
Restrict returned articles based on whether they are marked as Needs Translation
Optional
languageCode Language Code string
Restrict returned articles based on language code (e.g. en, fr, etc.)
Optional
updatedAtBefore Updated At Before string
Restrict returned articles based on whether they were published before a certain date. E.g. 2025-01-01
Optional
updatedAtAfter Updated At After string
Restrict returned articles based on whether they were published after a certain date. E.g. 2025-01-01
Optional
workingCopy Working Copy boolean
Returns the latest rather than currently published versions
Optional
maxResults Max Results integer
The maximum number of articles to return
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
helpdocs-list-articles
Version
0.0.3
App
HelpDocs
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes