View as Markdown
Salesforce icon

Salesforce ACTION

List Object Fields

List the field names for a Salesforce object type. Use this to discover valid field names before calling Find Records, SOQL Query or any create/update action. Use Describe Object instead when you also need field types, required flags and picklist values. 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 Object Fields 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-object-fields",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    salesforce_rest_api: { authProvisionId: "apn_xxxxxxx" },
    sobjectType: "SObject Type",
    customOnly: true,
  },
})

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 Object Fields inputs
Property Type Description
sobjectType SObject Type string
The type of object to list fields of
Required Dynamic
customOnly Custom Only boolean
Set to true to only list custom fields
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-object-fields
Version
0.0.5
App
Salesforce
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes