View as Markdown
Salesforce icon

Salesforce ACTION

Search Object Records

Search for records of one object type using a parameterized SOSL search. Use Text Search to search across several object types at once, or SOQL Query for exact field filters. SOSL matches indexed text fields, so it finds partial words but will not filter on numeric or date criteria. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Salesforce account once, then configure and run Search Object Records 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-search-string",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    salesforce_rest_api: { authProvisionId: "apn_xxxxxxx" },
    sobjectType: "SObject Type",
    searchTerm: "Search Term",
  },
})

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.

Search Object Records inputs
Property Type Description
sobjectType SObject Type string
The type of object to search for records
Required Dynamic
searchTerm Search Term string
The term to search for
Required
fields 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-search-string
Version
0.0.11
App
Salesforce
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes