View as Markdown
Salesforce icon

Salesforce ACTION

Describe Object

Get field metadata for a Salesforce object type, including field names, types, required status, and picklist values. Use before Create Record or Update Record to discover available fields and valid picklist values. For picklist fields (like StageName on Opportunity, Status on Case), this returns all valid values — use the API value, not the display label. Use the fieldsFilter parameter to narrow results — full object descriptions can be very large (100+ fields). Use List Objects if you're unsure of the object's API name. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Salesforce account once, then configure and run Describe Object 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-describe-object",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    salesforce_rest_api: { authProvisionId: "apn_xxxxxxx" },
    objectType: "Object Type",
    fieldsFilter: "Fields Filter",
  },
})

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.

Describe Object inputs
Property Type Description
objectType Object Type string
The Salesforce object API name (e.g. Account, Contact, Opportunity, CustomObject__c). Use List Objects to discover available object types.
Required
fieldsFilter Fields Filter string
Optional keyword to filter field names and labels (case-insensitive). For example, stage returns fields like StageName, ForecastCategoryName. Omit to return all 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-describe-object
Version
0.0.4
App
Salesforce
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
No