sf_get_record

Pack: salesforce · Endpoint: https://gateway.pipeworx.io/salesforce/mcp

Fetch a single Salesforce record by ID. Specify object type (e.g., ‘Account’, ‘Contact’, ‘Opportunity’) and record ID. Returns all fields.

Parameters

NameTypeRequiredDescription
objectstringyesSObject type (e.g., “Account”, “Contact”, “Opportunity”)
idstringyesSalesforce record ID
fieldsstringnoComma-separated field names (optional)

Example call

Arguments

{
  "object": "Account",
  "id": "001xx000003DHP"
}

curl

curl -X POST https://gateway.pipeworx.io/salesforce/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"sf_get_record","arguments":{"object":"Account","id":"001xx000003DHP"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('sf_get_record', {
  "object": "Account",
  "id": "001xx000003DHP"
});

More examples

{
  "object": "Contact",
  "id": "003xx000004TM1",
  "fields": "Id,FirstName,LastName,Email"
}

Response shape

FieldTypeDescription
IdstringSalesforce record ID
errorstringError code if request failed
messagestringError message if request failed
Full JSON Schema
{
  "type": "object",
  "properties": {
    "Id": {
      "type": "string",
      "description": "Salesforce record ID"
    },
    "error": {
      "type": "string",
      "description": "Error code if request failed"
    },
    "message": {
      "type": "string",
      "description": "Error message if request failed"
    }
  },
  "additionalProperties": true
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "salesforce": {
      "url": "https://gateway.pipeworx.io/salesforce/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build May 9, 2026