Salesforce
Interact with Salesforce CRM
Integrate Salesforce into your workflow. Manage accounts, contacts, leads, opportunities, cases, and tasks with powerful automation capabilities.
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
limit | string | No | No description |
fields | string | No | Comma-separated field API names (e.g., "Id,Name,Industry,Phone") |
orderBy | string | No | Field and direction for sorting (e.g., "Name ASC" or "CreatedDate DESC") |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Accounts data |
↳ paging | object | Pagination information from Salesforce API |
↳ nextRecordsUrl | string | URL to fetch the next batch of records (present when done is false) |
↳ totalSize | number | Total number of records matching the query (may exceed records returned) |
↳ done | boolean | Whether all records have been returned (false if more batches exist) |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ accounts | array | Array of account objects |
↳ success | boolean | Salesforce operation success |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
name | string | Yes | No description |
type | string | No | No description |
industry | string | No | No description |
phone | string | No | No description |
website | string | No | No description |
billingStreet | string | No | No description |
billingCity | string | No | No description |
billingState | string | No | No description |
billingPostalCode | string | No | No description |
billingCountry | string | No | No description |
description | string | No | No description |
annualRevenue | string | No | No description |
numberOfEmployees | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created account data |
↳ id | string | The Salesforce ID of the newly created record |
↳ success | boolean | Whether the create operation was successful |
↳ created | boolean | Whether the record was created (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
accountId | string | Yes | No description |
name | string | No | No description |
type | string | No | No description |
industry | string | No | No description |
phone | string | No | No description |
website | string | No | No description |
billingStreet | string | No | No description |
billingCity | string | No | No description |
billingState | string | No | No description |
billingPostalCode | string | No | No description |
billingCountry | string | No | No description |
description | string | No | No description |
annualRevenue | string | No | No description |
numberOfEmployees | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated account data |
↳ id | string | The Salesforce ID of the updated record |
↳ updated | boolean | Whether the record was updated (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
accountId | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deleted account data |
↳ id | string | The Salesforce ID of the deleted record |
↳ deleted | boolean | Whether the record was deleted (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
contactId | string | No | Salesforce Contact ID (18-character string starting with 003) to get a single contact |
limit | string | No | No description |
fields | string | No | Comma-separated field API names (e.g., "Id,FirstName,LastName,Email,Phone") |
orderBy | string | No | Field and direction for sorting (e.g., "LastName ASC"). Only for list query. |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Contact(s) data |
↳ paging | object | Pagination information from Salesforce API |
↳ nextRecordsUrl | string | URL to fetch the next batch of records (present when done is false) |
↳ totalSize | number | Total number of records matching the query (may exceed records returned) |
↳ done | boolean | Whether all records have been returned (false if more batches exist) |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ contacts | array | Array of contacts (list query) |
↳ contact | object | Single contact (by ID) |
↳ singleContact | boolean | Whether single contact was returned |
↳ success | boolean | Salesforce operation success |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
lastName | string | Yes | No description |
firstName | string | No | No description |
email | string | No | No description |
phone | string | No | No description |
accountId | string | No | No description |
title | string | No | No description |
department | string | No | No description |
mailingStreet | string | No | No description |
mailingCity | string | No | No description |
mailingState | string | No | No description |
mailingPostalCode | string | No | No description |
mailingCountry | string | No | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created contact data |
↳ id | string | The Salesforce ID of the newly created record |
↳ success | boolean | Whether the create operation was successful |
↳ created | boolean | Whether the record was created (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
contactId | string | Yes | No description |
lastName | string | No | No description |
firstName | string | No | No description |
email | string | No | No description |
phone | string | No | No description |
accountId | string | No | No description |
title | string | No | No description |
department | string | No | No description |
mailingStreet | string | No | No description |
mailingCity | string | No | No description |
mailingState | string | No | No description |
mailingPostalCode | string | No | No description |
mailingCountry | string | No | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated contact data |
↳ id | string | The Salesforce ID of the updated record |
↳ updated | boolean | Whether the record was updated (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
contactId | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deleted contact data |
↳ id | string | The Salesforce ID of the deleted record |
↳ deleted | boolean | Whether the record was deleted (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
leadId | string | No | Salesforce Lead ID (18-character string starting with 00Q) to get a single lead |
limit | string | No | No description |
fields | string | No | No description |
orderBy | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Lead data |
↳ paging | object | Pagination information from Salesforce API |
↳ nextRecordsUrl | string | URL to fetch the next batch of records (present when done is false) |
↳ totalSize | number | Total number of records matching the query (may exceed records returned) |
↳ done | boolean | Whether all records have been returned (false if more batches exist) |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ lead | object | Single lead object (when leadId provided) |
↳ leads | array | Array of lead objects (when listing) |
↳ singleLead | boolean | Whether single lead was returned |
↳ success | boolean | Operation success status |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
lastName | string | Yes | No description |
company | string | Yes | No description |
firstName | string | No | No description |
email | string | No | No description |
phone | string | No | No description |
status | string | No | No description |
leadSource | string | No | No description |
title | string | No | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created lead data |
↳ id | string | The Salesforce ID of the newly created record |
↳ success | boolean | Whether the create operation was successful |
↳ created | boolean | Whether the record was created (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
leadId | string | Yes | No description |
lastName | string | No | No description |
company | string | No | No description |
firstName | string | No | No description |
email | string | No | No description |
phone | string | No | No description |
status | string | No | No description |
leadSource | string | No | No description |
title | string | No | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated lead data |
↳ id | string | The Salesforce ID of the updated record |
↳ updated | boolean | Whether the record was updated (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
leadId | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deleted lead data |
↳ id | string | The Salesforce ID of the deleted record |
↳ deleted | boolean | Whether the record was deleted (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
opportunityId | string | No | Salesforce Opportunity ID (18-character string starting with 006) to get a single opportunity |
limit | string | No | No description |
fields | string | No | No description |
orderBy | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Opportunity data |
↳ paging | object | Pagination information from Salesforce API |
↳ nextRecordsUrl | string | URL to fetch the next batch of records (present when done is false) |
↳ totalSize | number | Total number of records matching the query (may exceed records returned) |
↳ done | boolean | Whether all records have been returned (false if more batches exist) |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ opportunity | object | Single opportunity object (when opportunityId provided) |
↳ opportunities | array | Array of opportunity objects (when listing) |
↳ success | boolean | Operation success status |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
name | string | Yes | No description |
stageName | string | Yes | No description |
closeDate | string | Yes | No description |
accountId | string | No | No description |
amount | string | No | No description |
probability | string | No | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created opportunity data |
↳ id | string | The Salesforce ID of the newly created record |
↳ success | boolean | Whether the create operation was successful |
↳ created | boolean | Whether the record was created (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
opportunityId | string | Yes | No description |
name | string | No | No description |
stageName | string | No | No description |
closeDate | string | No | No description |
accountId | string | No | No description |
amount | string | No | No description |
probability | string | No | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated opportunity data |
↳ id | string | The Salesforce ID of the updated record |
↳ updated | boolean | Whether the record was updated (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
opportunityId | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deleted opportunity data |
↳ id | string | The Salesforce ID of the deleted record |
↳ deleted | boolean | Whether the record was deleted (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
caseId | string | No | Salesforce Case ID (18-character string starting with 500) to get a single case |
limit | string | No | No description |
fields | string | No | No description |
orderBy | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Case data |
↳ paging | object | Pagination information from Salesforce API |
↳ nextRecordsUrl | string | URL to fetch the next batch of records (present when done is false) |
↳ totalSize | number | Total number of records matching the query (may exceed records returned) |
↳ done | boolean | Whether all records have been returned (false if more batches exist) |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ case | object | Single case object (when caseId provided) |
↳ cases | array | Array of case objects (when listing) |
↳ success | boolean | Operation success status |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
subject | string | Yes | No description |
status | string | No | No description |
priority | string | No | No description |
origin | string | No | No description |
contactId | string | No | No description |
accountId | string | No | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created case data |
↳ id | string | The Salesforce ID of the newly created record |
↳ success | boolean | Whether the create operation was successful |
↳ created | boolean | Whether the record was created (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
caseId | string | Yes | No description |
subject | string | No | No description |
status | string | No | No description |
priority | string | No | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated case data |
↳ id | string | The Salesforce ID of the updated record |
↳ updated | boolean | Whether the record was updated (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
caseId | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deleted case data |
↳ id | string | The Salesforce ID of the deleted record |
↳ deleted | boolean | Whether the record was deleted (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
taskId | string | No | Salesforce Task ID (18-character string starting with 00T) to get a single task |
limit | string | No | No description |
fields | string | No | No description |
orderBy | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Task data |
↳ paging | object | Pagination information from Salesforce API |
↳ nextRecordsUrl | string | URL to fetch the next batch of records (present when done is false) |
↳ totalSize | number | Total number of records matching the query (may exceed records returned) |
↳ done | boolean | Whether all records have been returned (false if more batches exist) |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ task | object | Single task object (when taskId provided) |
↳ tasks | array | Array of task objects (when listing) |
↳ success | boolean | Operation success status |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
subject | string | Yes | No description |
status | string | No | No description |
priority | string | No | No description |
activityDate | string | No | No description |
whoId | string | No | No description |
whatId | string | No | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created task data |
↳ id | string | The Salesforce ID of the newly created record |
↳ success | boolean | Whether the create operation was successful |
↳ created | boolean | Whether the record was created (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
taskId | string | Yes | No description |
subject | string | No | No description |
status | string | No | No description |
priority | string | No | No description |
activityDate | string | No | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated task data |
↳ id | string | The Salesforce ID of the updated record |
↳ updated | boolean | Whether the record was updated (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
taskId | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deleted task data |
↳ id | string | The Salesforce ID of the deleted record |
↳ deleted | boolean | Whether the record was deleted (always true on success) |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
folderName | string | No | No description |
searchTerm | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Reports data |
↳ totalReturned | number | Number of items returned |
↳ success | boolean | Salesforce operation success |
↳ reports | array | Array of report objects |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
reportId | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Report metadata |
↳ report | object | Report metadata object |
↳ reportId | string | Report ID |
↳ success | boolean | Salesforce operation success |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
reportId | string | Yes | No description |
includeDetails | string | No | No description |
filters | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Report results |
↳ reportId | string | Report ID |
↳ reportMetadata | object | Report metadata including name, format, and filter definitions |
↳ reportExtendedMetadata | object | Extended metadata for aggregate columns and groupings |
↳ factMap | object | Report data organized by groupings with aggregates and row data |
↳ groupingsDown | object | Row grouping hierarchy and values |
↳ groupingsAcross | object | Column grouping hierarchy and values |
↳ hasDetailRows | boolean | Whether the report includes detail-level row data |
↳ allData | boolean | Whether all data is returned (false if truncated due to size limits) |
↳ reportName | string | Display name of the report |
↳ reportFormat | string | Report format type (TABULAR, SUMMARY, MATRIX, JOINED) |
↳ success | boolean | Salesforce operation success |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Report types data |
↳ totalReturned | number | Number of items returned |
↳ success | boolean | Salesforce operation success |
↳ reportTypes | array | Array of report type objects |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
folderName | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Dashboards data |
↳ totalReturned | number | Number of items returned |
↳ success | boolean | Salesforce operation success |
↳ dashboards | array | Array of dashboard objects |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
dashboardId | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Dashboard data |
↳ dashboard | object | Full dashboard details object |
↳ dashboardId | string | Dashboard ID |
↳ components | array | Array of dashboard component data with visualizations and filters |
↳ dashboardName | string | Display name of the dashboard |
↳ folderId | string | ID of the folder containing the dashboard |
↳ runningUser | object | User context under which the dashboard data was retrieved |
↳ success | boolean | Salesforce operation success |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
dashboardId | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Refreshed dashboard data |
↳ dashboard | object | Full dashboard details object |
↳ dashboardId | string | Dashboard ID |
↳ components | array | Array of dashboard component data with fresh visualizations |
↳ status | object | Dashboard refresh status information |
↳ dashboardName | string | Display name of the dashboard |
↳ refreshDate | string | ISO 8601 timestamp when the dashboard was last refreshed |
↳ success | boolean | Salesforce operation success |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
query | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Query results |
↳ records | array | Array of sObject records matching the query |
↳ query | string | The executed SOQL query |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ success | boolean | Salesforce operation success |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
nextRecordsUrl | string | Yes | The nextRecordsUrl value from a previous query response (e.g., /services/data/v59.0/query/01g...) |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Query results |
↳ records | array | Array of sObject records matching the query |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ success | boolean | Salesforce operation success |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
objectName | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Object metadata |
↳ objectName | string | API name of the object (e.g., Account, Contact) |
↳ label | string | Human-readable singular label for the object |
↳ labelPlural | string | Human-readable plural label for the object |
↳ fields | array | Array of field metadata objects |
↳ name | string | API name of the field |
↳ label | string | Display label of the field |
↳ type | string | Field data type (string, boolean, int, double, date, etc.) |
↳ length | number | Maximum length for text fields |
↳ precision | number | Precision for numeric fields |
↳ scale | number | Scale for numeric fields |
↳ nillable | boolean | Whether the field can be null |
↳ unique | boolean | Whether values must be unique |
↳ createable | boolean | Whether field can be set on create |
↳ updateable | boolean | Whether field can be updated |
↳ defaultedOnCreate | boolean | Whether field has default value on create |
↳ calculated | boolean | Whether field is a formula field |
↳ autoNumber | boolean | Whether field is auto-number |
↳ externalId | boolean | Whether field is an external ID |
↳ idLookup | boolean | Whether field can be used in ID lookup |
↳ inlineHelpText | string | Help text for the field |
↳ picklistValues | array | Available picklist values for picklist fields |
↳ referenceTo | array | Objects this field can reference (for lookup fields) |
↳ relationshipName | string | Relationship name for lookup fields |
↳ custom | boolean | Whether this is a custom field |
↳ filterable | boolean | Whether field can be used in SOQL filter |
↳ groupable | boolean | Whether field can be used in GROUP BY |
↳ sortable | boolean | Whether field can be used in ORDER BY |
↳ keyPrefix | string | Three-character prefix used in record IDs (e.g., "001" for Account) |
↳ queryable | boolean | Whether the object can be queried via SOQL |
↳ createable | boolean | Whether records can be created for this object |
↳ updateable | boolean | Whether records can be updated for this object |
↳ deletable | boolean | Whether records can be deleted for this object |
↳ childRelationships | array | Array of child relationship metadata for related objects |
↳ recordTypeInfos | array | Array of record type information for the object |
↳ fieldCount | number | Total number of fields on the object |
↳ success | boolean | Salesforce operation success |
| Parameter | Type | Required | Description |
|---|
idToken | string | No | No description |
instanceUrl | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Objects list |
↳ objects | array | Array of sObject metadata |
↳ name | string | API name of the object |
↳ label | string | Display label of the object |
↳ labelPlural | string | Plural display label |
↳ keyPrefix | string | Three-character ID prefix |
↳ custom | boolean | Whether this is a custom object |
↳ queryable | boolean | Whether object can be queried |
↳ createable | boolean | Whether records can be created |
↳ updateable | boolean | Whether records can be updated |
↳ deletable | boolean | Whether records can be deleted |
↳ searchable | boolean | Whether object is searchable |
↳ triggerable | boolean | Whether triggers are supported |
↳ layoutable | boolean | Whether page layouts are supported |
↳ replicateable | boolean | Whether object can be replicated |
↳ retrieveable | boolean | Whether records can be retrieved |
↳ undeletable | boolean | Whether records can be undeleted |
↳ urls | object | URLs for accessing object resources |
↳ encoding | string | Character encoding for the organization (e.g., UTF-8) |
↳ maxBatchSize | number | Maximum number of records that can be returned in a single query batch (typically 200) |
↳ totalReturned | number | Number of objects returned |
↳ success | boolean | Salesforce operation success |
