View as Markdown
Zendesk icon

Zendesk ACTION

List Articles

Retrieves a list of articles. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Zendesk 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: "zendesk-list-articles",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    zendesk: { authProvisionId: "apn_xxxxxxx" },
    locale: "Locale",
    categoryId: "Article Category ID",
  },
})

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
locale Locale string
The locale of the article
Optional Dynamic
categoryId Article Category ID string
The ID of the article category
Optional Dynamic
sectionId Section ID string
The ID of the section
Optional Dynamic
userId User ID string
The ID of the user
Optional Dynamic
limit Limit integer
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
zendesk-list-articles
Version
0.0.11
App
Zendesk
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes