View as Markdown
Salesforce icon

Salesforce ACTION

SOSL Search (Object Search)

Run a SOSL text search with guided prompts. Prefer Text Search for agent and API use - it takes a plain keyword and searches several object types at once. 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 SOSL Search (Object Search) 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-sosl-search",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    salesforce_rest_api: { authProvisionId: "apn_xxxxxxx" },
    search: "SOSL Query",
  },
})

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.

SOSL Search (Object Search) inputs
Property Type Description
search SOSL Query string
A SOSL search query. See the documentation for examples and more information.
Required

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-sosl-search
Version
0.2.15
App
Salesforce
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes