View as Markdown
Salesforce icon

Salesforce ACTION

SOQL Query (Object Query)

Run a SOQL query with guided prompts for the object, fields and filter. Prefer SOQL Query for agent and API use - it accepts a complete query string and pages through every result, while this action returns only the first batch. SOQL filters on exact field values; use Text Search for keyword search. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Salesforce account once, then configure and run SOQL Query (Object Query) 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-soql-search",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    salesforce_rest_api: { authProvisionId: "apn_xxxxxxx" },
    query: "SOQL 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.

SOQL Query (Object Query) inputs
Property Type Description
query SOQL Query string
A SOQL 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-soql-search
Version
0.2.16
App
Salesforce
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes