View as Markdown
Salesforce icon

Salesforce ACTION

Get Record by ID

Retrieve one Salesforce record of any object type by its record ID. Use Find Records to look up records by criteria, or SOQL Query when you need related fields or a filtered set. Use List Objects to discover object types if you are unsure of the type 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 Get Record by ID 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-get-record-by-id",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    salesforce_rest_api: { authProvisionId: "apn_xxxxxxx" },
    sobjectType: "SObject Type",
    recordId: "Record 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.

Get Record by ID inputs
Property Type Description
sobjectType SObject Type string
The type of object to retrieve a record of
Required Dynamic
recordId Record ID string
The ID of the record to retrieve
Required Dynamic
fieldsToObtain Fields to Obtain string[]
Select the field(s) to obtain for the selected record(s) (or all records).
Required Dynamic

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-get-record-by-id
Version
0.0.5
App
Salesforce
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes