View as Markdown
Salesforce icon

Salesforce ACTION

List Knowledge Articles

List Salesforce Knowledge articles, newest first. Returns the article container records (KnowledgeArticle), not the published article bodies - use Get Knowledge Articles to read article content, and List Knowledge Data Category Groups to discover the categories articles are filed under. This can return a lot of records on a mature org, so set Limit. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Salesforce account once, then configure and run List Knowledge 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: "salesforce_rest_api-list-knowledge-articles",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    salesforce_rest_api: { authProvisionId: "apn_xxxxxxx" },
    fields: ["Fields"],
    limit: 10,
  },
})

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 Knowledge Articles inputs
Property Type Description
fields Fields string[]
The KnowledgeArticle fields to return. Defaults to every field on the object. Id is always returned.
Optional Dynamic
limit Limit integer
The maximum number of articles to return. Valid values are integers from 1 through 1000. Omit to return every article Salesforce sends in one batch.
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
salesforce_rest_api-list-knowledge-articles
Version
0.1.3
App
Salesforce
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes