Salesforce

Interact with Salesforce CRM

The Salesforce tool enables you to connect directly to your Salesforce CRM and perform a wide range of customer relationship management operations within your agentic workflows. With seamless and secure integration, you can efficiently access and automate key business processes across your sales, support, and marketing data.

With the Salesforce tool, you can:

  • Retrieve accounts: Use the salesforce_get_accounts operation to fetch Accounts from Salesforce with custom filters, sorting, and field selection.
  • Create accounts: Automatically add new Accounts to Salesforce using the salesforce_create_account operation, specifying details like name, industry, and billing address.
  • Manage contacts: (If provided, similar tooling available for Contacts—add, update, or fetch contacts as needed.)
  • Handle leads & opportunities: Integrate lead and opportunity management into your workflow, letting your agents capture, qualify, and update sales pipeline data.
  • Track cases & tasks: Automate customer support and follow-up activities by interacting with Cases and Tasks within Salesforce.

The Salesforce tool is ideal for workflows where your agents need to streamline sales, account management, lead generation, and support operations. Whether your agents are syncing data across platforms, providing real-time customer insights, or automating routine CRM updates, the Salesforce tool brings the full power and extensibility of Salesforce into your programmatic, agent-driven processes.

Usage Instructions

Integrate Salesforce into your workflow. Manage accounts, contacts, leads, opportunities, cases, and tasks with powerful automation capabilities.

Tools

salesforce_get_accounts

Retrieve accounts from Salesforce CRM

Input

ParameterTypeRequiredDescription
idTokenstringNoThe ID token from Salesforce OAuth (contains instance URL)
instanceUrlstringNoThe Salesforce instance URL
limitstringNoMaximum number of results (default: 100, max: 2000)
fieldsstringNoComma-separated field API names (e.g., "Id,Name,Industry,Phone")
orderBystringNoField and direction for sorting (e.g., "Name ASC" or "CreatedDate DESC")

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectAccounts data
pagingobjectPagination information from Salesforce API
nextRecordsUrlstringURL to fetch the next batch of records (present when done is false)
totalSizenumberTotal number of records matching the query (may exceed records returned)
donebooleanWhether all records have been returned (false if more batches exist)
metadataobjectResponse metadata
totalReturnednumberNumber of records returned in this response
hasMorebooleanWhether more records exist (inverse of done)
accountsarrayArray of account objects
successbooleanSalesforce operation success

salesforce_create_account

Create a new account in Salesforce CRM

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
namestringYesAccount name (required)
typestringNoAccount type (e.g., Customer, Partner, Prospect)
industrystringNoIndustry (e.g., Technology, Healthcare, Finance)
phonestringNoPhone number
websitestringNoWebsite URL
billingStreetstringNoBilling street address
billingCitystringNoBilling city
billingStatestringNoBilling state/province
billingPostalCodestringNoBilling postal code
billingCountrystringNoBilling country
descriptionstringNoAccount description
annualRevenuestringNoAnnual revenue as a number
numberOfEmployeesstringNoNumber of employees as an integer

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated account data
idstringThe Salesforce ID of the newly created record
successbooleanWhether the create operation was successful
createdbooleanWhether the record was created (always true on success)

salesforce_update_account

Update an existing account in Salesforce CRM

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
accountIdstringYesSalesforce Account ID to update (18-character string starting with 001)
namestringNoAccount name
typestringNoAccount type (e.g., Customer, Partner, Prospect)
industrystringNoIndustry (e.g., Technology, Healthcare, Finance)
phonestringNoPhone number
websitestringNoWebsite URL
billingStreetstringNoBilling street address
billingCitystringNoBilling city
billingStatestringNoBilling state/province
billingPostalCodestringNoBilling postal code
billingCountrystringNoBilling country
descriptionstringNoAccount description
annualRevenuestringNoAnnual revenue as a number
numberOfEmployeesstringNoNumber of employees as an integer

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated account data
idstringThe Salesforce ID of the updated record
updatedbooleanWhether the record was updated (always true on success)

salesforce_delete_account

Delete an account from Salesforce CRM

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
accountIdstringYesSalesforce Account ID to delete (18-character string starting with 001)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectDeleted account data
idstringThe Salesforce ID of the deleted record
deletedbooleanWhether the record was deleted (always true on success)

salesforce_get_contacts

Get contact(s) from Salesforce - single contact if ID provided, or list if not

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
contactIdstringNoSalesforce Contact ID (18-character string starting with 003) to get a single contact
limitstringNoMaximum number of results (default: 100, max: 2000). Only for list query.
fieldsstringNoComma-separated field API names (e.g., "Id,FirstName,LastName,Email,Phone")
orderBystringNoField and direction for sorting (e.g., "LastName ASC"). Only for list query.

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectContact(s) data
pagingobjectPagination information from Salesforce API
nextRecordsUrlstringURL to fetch the next batch of records (present when done is false)
totalSizenumberTotal number of records matching the query (may exceed records returned)
donebooleanWhether all records have been returned (false if more batches exist)
metadataobjectResponse metadata
totalReturnednumberNumber of records returned in this response
hasMorebooleanWhether more records exist (inverse of done)
contactsarrayArray of contacts (list query)
contactobjectSingle contact (by ID)
singleContactbooleanWhether single contact was returned
successbooleanSalesforce operation success

salesforce_create_contact

Create a new contact in Salesforce CRM

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
lastNamestringYesLast name (required)
firstNamestringNoFirst name
emailstringNoEmail address
phonestringNoPhone number
accountIdstringNoSalesforce Account ID (18-character string starting with 001)
titlestringNoNo description
departmentstringNoDepartment
mailingStreetstringNoMailing street
mailingCitystringNoMailing city
mailingStatestringNoMailing state
mailingPostalCodestringNoMailing postal code
mailingCountrystringNoMailing country
descriptionstringNoContact description

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated contact data
idstringThe Salesforce ID of the newly created record
successbooleanWhether the create operation was successful
createdbooleanWhether the record was created (always true on success)

salesforce_update_contact

Update an existing contact in Salesforce CRM

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
contactIdstringYesSalesforce Contact ID to update (18-character string starting with 003)
lastNamestringNoLast name
firstNamestringNoFirst name
emailstringNoEmail address
phonestringNoPhone number
accountIdstringNoSalesforce Account ID (18-character string starting with 001)
titlestringNoNo description
departmentstringNoDepartment
mailingStreetstringNoMailing street
mailingCitystringNoMailing city
mailingStatestringNoMailing state
mailingPostalCodestringNoMailing postal code
mailingCountrystringNoMailing country
descriptionstringNoContact description

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated contact data
idstringThe Salesforce ID of the updated record
updatedbooleanWhether the record was updated (always true on success)

salesforce_delete_contact

Delete a contact from Salesforce CRM

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
contactIdstringYesSalesforce Contact ID to delete (18-character string starting with 003)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectDeleted contact data
idstringThe Salesforce ID of the deleted record
deletedbooleanWhether the record was deleted (always true on success)

salesforce_get_leads

Get lead(s) from Salesforce

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
leadIdstringNoSalesforce Lead ID (18-character string starting with 00Q) to get a single lead
limitstringNoMaximum number of results to return (default: 100)
fieldsstringNoComma-separated list of field API names to return
orderBystringNoField and direction for sorting (e.g., LastName ASC)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectLead data
pagingobjectPagination information from Salesforce API
nextRecordsUrlstringURL to fetch the next batch of records (present when done is false)
totalSizenumberTotal number of records matching the query (may exceed records returned)
donebooleanWhether all records have been returned (false if more batches exist)
metadataobjectResponse metadata
totalReturnednumberNumber of records returned in this response
hasMorebooleanWhether more records exist (inverse of done)
leadobjectSingle lead object (when leadId provided)
leadsarrayArray of lead objects (when listing)
singleLeadbooleanWhether single lead was returned
successbooleanOperation success status

salesforce_create_lead

Create a new lead

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
lastNamestringYesLast name (required)
companystringYesCompany name (required)
firstNamestringNoFirst name
emailstringNoEmail address
phonestringNoPhone number
statusstringNoLead status (e.g., Open, Working, Closed)
leadSourcestringNoLead source (e.g., Web, Referral, Campaign)
titlestringNoNo description
descriptionstringNoLead description

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated lead data
idstringThe Salesforce ID of the newly created record
successbooleanWhether the create operation was successful
createdbooleanWhether the record was created (always true on success)

salesforce_update_lead

Update an existing lead

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
leadIdstringYesSalesforce Lead ID to update (18-character string starting with 00Q)
lastNamestringNoLast name
companystringNoCompany name
firstNamestringNoFirst name
emailstringNoEmail address
phonestringNoPhone number
statusstringNoLead status (e.g., Open, Working, Closed)
leadSourcestringNoLead source (e.g., Web, Referral, Campaign)
titlestringNoNo description
descriptionstringNoLead description

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated lead data
idstringThe Salesforce ID of the updated record
updatedbooleanWhether the record was updated (always true on success)

salesforce_delete_lead

Delete a lead

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
leadIdstringYesSalesforce Lead ID to delete (18-character string starting with 00Q)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectDeleted lead data
idstringThe Salesforce ID of the deleted record
deletedbooleanWhether the record was deleted (always true on success)

salesforce_get_opportunities

Get opportunity(ies) from Salesforce

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
opportunityIdstringNoSalesforce Opportunity ID (18-character string starting with 006) to get a single opportunity
limitstringNoMaximum number of results to return (default: 100)
fieldsstringNoComma-separated list of field API names to return
orderBystringNoField and direction for sorting (e.g., CloseDate DESC)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectOpportunity data
pagingobjectPagination information from Salesforce API
nextRecordsUrlstringURL to fetch the next batch of records (present when done is false)
totalSizenumberTotal number of records matching the query (may exceed records returned)
donebooleanWhether all records have been returned (false if more batches exist)
metadataobjectResponse metadata
totalReturnednumberNumber of records returned in this response
hasMorebooleanWhether more records exist (inverse of done)
opportunityobjectSingle opportunity object (when opportunityId provided)
opportunitiesarrayArray of opportunity objects (when listing)
successbooleanOperation success status

salesforce_create_opportunity

Create a new opportunity

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
namestringYesOpportunity name (required)
stageNamestringYesStage name (required, e.g., Prospecting, Qualification, Closed Won)
closeDatestringYesClose date in YYYY-MM-DD format (required)
accountIdstringNoSalesforce Account ID (18-character string starting with 001)
amountstringNoDeal amount as a number
probabilitystringNoWin probability as integer (0-100)
descriptionstringNoOpportunity description

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated opportunity data
idstringThe Salesforce ID of the newly created record
successbooleanWhether the create operation was successful
createdbooleanWhether the record was created (always true on success)

salesforce_update_opportunity

Update an existing opportunity

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
opportunityIdstringYesSalesforce Opportunity ID to update (18-character string starting with 006)
namestringNoOpportunity name
stageNamestringNoStage name (e.g., Prospecting, Qualification, Closed Won)
closeDatestringNoClose date in YYYY-MM-DD format
accountIdstringNoSalesforce Account ID (18-character string starting with 001)
amountstringNoDeal amount as a number
probabilitystringNoWin probability as integer (0-100)
descriptionstringNoOpportunity description

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated opportunity data
idstringThe Salesforce ID of the updated record
updatedbooleanWhether the record was updated (always true on success)

salesforce_delete_opportunity

Delete an opportunity

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
opportunityIdstringYesSalesforce Opportunity ID to delete (18-character string starting with 006)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectDeleted opportunity data
idstringThe Salesforce ID of the deleted record
deletedbooleanWhether the record was deleted (always true on success)

salesforce_get_cases

Get case(s) from Salesforce

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
caseIdstringNoSalesforce Case ID (18-character string starting with 500) to get a single case
limitstringNoMaximum number of results to return (default: 100)
fieldsstringNoComma-separated list of field API names to return
orderBystringNoField and direction for sorting (e.g., CreatedDate DESC)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCase data
pagingobjectPagination information from Salesforce API
nextRecordsUrlstringURL to fetch the next batch of records (present when done is false)
totalSizenumberTotal number of records matching the query (may exceed records returned)
donebooleanWhether all records have been returned (false if more batches exist)
metadataobjectResponse metadata
totalReturnednumberNumber of records returned in this response
hasMorebooleanWhether more records exist (inverse of done)
caseobjectSingle case object (when caseId provided)
casesarrayArray of case objects (when listing)
successbooleanOperation success status

salesforce_create_case

Create a new case

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
subjectstringYesCase subject (required)
statusstringNoStatus (e.g., New, Working, Escalated)
prioritystringNoPriority (e.g., Low, Medium, High)
originstringNoOrigin (e.g., Phone, Email, Web)
contactIdstringNoSalesforce Contact ID (18-character string starting with 003)
accountIdstringNoSalesforce Account ID (18-character string starting with 001)
descriptionstringNoCase description

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated case data
idstringThe Salesforce ID of the newly created record
successbooleanWhether the create operation was successful
createdbooleanWhether the record was created (always true on success)

salesforce_update_case

Update an existing case

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
caseIdstringYesSalesforce Case ID to update (18-character string starting with 500)
subjectstringNoCase subject
statusstringNoStatus (e.g., New, Working, Escalated, Closed)
prioritystringNoPriority (e.g., Low, Medium, High)
descriptionstringNoCase description

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated case data
idstringThe Salesforce ID of the updated record
updatedbooleanWhether the record was updated (always true on success)

salesforce_delete_case

Delete a case

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
caseIdstringYesSalesforce Case ID to delete (18-character string starting with 500)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectDeleted case data
idstringThe Salesforce ID of the deleted record
deletedbooleanWhether the record was deleted (always true on success)

salesforce_get_tasks

Get task(s) from Salesforce

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
taskIdstringNoSalesforce Task ID (18-character string starting with 00T) to get a single task
limitstringNoMaximum number of results to return (default: 100)
fieldsstringNoComma-separated list of field API names to return
orderBystringNoField and direction for sorting (e.g., ActivityDate DESC)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectTask data
pagingobjectPagination information from Salesforce API
nextRecordsUrlstringURL to fetch the next batch of records (present when done is false)
totalSizenumberTotal number of records matching the query (may exceed records returned)
donebooleanWhether all records have been returned (false if more batches exist)
metadataobjectResponse metadata
totalReturnednumberNumber of records returned in this response
hasMorebooleanWhether more records exist (inverse of done)
taskobjectSingle task object (when taskId provided)
tasksarrayArray of task objects (when listing)
successbooleanOperation success status

salesforce_create_task

Create a new task

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
subjectstringYesTask subject (required)
statusstringNoStatus (e.g., Not Started, In Progress, Completed)
prioritystringNoPriority (e.g., Low, Normal, High)
activityDatestringNoDue date in YYYY-MM-DD format
whoIdstringNoRelated Contact ID (003...) or Lead ID (00Q...)
whatIdstringNoRelated Account ID (001...) or Opportunity ID (006...)
descriptionstringNoTask description

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated task data
idstringThe Salesforce ID of the newly created record
successbooleanWhether the create operation was successful
createdbooleanWhether the record was created (always true on success)

salesforce_update_task

Update an existing task

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
taskIdstringYesSalesforce Task ID to update (18-character string starting with 00T)
subjectstringNoTask subject
statusstringNoStatus (e.g., Not Started, In Progress, Completed)
prioritystringNoPriority (e.g., Low, Normal, High)
activityDatestringNoDue date in YYYY-MM-DD format
descriptionstringNoTask description

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated task data
idstringThe Salesforce ID of the updated record
updatedbooleanWhether the record was updated (always true on success)

salesforce_delete_task

Delete a task

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
taskIdstringYesSalesforce Task ID to delete (18-character string starting with 00T)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectDeleted task data
idstringThe Salesforce ID of the deleted record
deletedbooleanWhether the record was deleted (always true on success)

salesforce_list_reports

Get a list of reports accessible by the current user

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
folderNamestringNoFilter reports by folder name (case-insensitive partial match)
searchTermstringNoSearch term to filter reports by name or description

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectReports data
totalReturnednumberNumber of items returned
successbooleanSalesforce operation success
reportsarrayArray of report objects

salesforce_get_report

Get metadata and describe information for a specific report

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
reportIdstringYesSalesforce Report ID (18-character string starting with 00O)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectReport metadata
reportobjectReport metadata object
reportIdstringReport ID
successbooleanSalesforce operation success

salesforce_run_report

Execute a report and retrieve the results

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
reportIdstringYesSalesforce Report ID (18-character string starting with 00O)
includeDetailsstringNoInclude detail rows (true/false, default: true)
filtersstringNoJSON array of report filter objects to apply

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectReport results
reportIdstringReport ID
reportMetadataobjectReport metadata including name, format, and filter definitions
reportExtendedMetadataobjectExtended metadata for aggregate columns and groupings
factMapobjectReport data organized by groupings with aggregates and row data
groupingsDownobjectRow grouping hierarchy and values
groupingsAcrossobjectColumn grouping hierarchy and values
hasDetailRowsbooleanWhether the report includes detail-level row data
allDatabooleanWhether all data is returned (false if truncated due to size limits)
reportNamestringDisplay name of the report
reportFormatstringReport format type (TABULAR, SUMMARY, MATRIX, JOINED)
successbooleanSalesforce operation success

salesforce_list_report_types

Get a list of available report types

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectReport types data
totalReturnednumberNumber of items returned
successbooleanSalesforce operation success
reportTypesarrayArray of report type objects

salesforce_list_dashboards

Get a list of dashboards accessible by the current user

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
folderNamestringNoFilter dashboards by folder name (case-insensitive partial match)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectDashboards data
totalReturnednumberNumber of items returned
successbooleanSalesforce operation success
dashboardsarrayArray of dashboard objects

salesforce_get_dashboard

Get details and results for a specific dashboard

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
dashboardIdstringYesSalesforce Dashboard ID (18-character string starting with 01Z)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectDashboard data
dashboardobjectFull dashboard details object
dashboardIdstringDashboard ID
componentsarrayArray of dashboard component data with visualizations and filters
dashboardNamestringDisplay name of the dashboard
folderIdstringID of the folder containing the dashboard
runningUserobjectUser context under which the dashboard data was retrieved
successbooleanSalesforce operation success

salesforce_refresh_dashboard

Refresh a dashboard to get the latest data

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
dashboardIdstringYesSalesforce Dashboard ID (18-character string starting with 01Z)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectRefreshed dashboard data
dashboardobjectFull dashboard details object
dashboardIdstringDashboard ID
componentsarrayArray of dashboard component data with fresh visualizations
statusobjectDashboard refresh status information
dashboardNamestringDisplay name of the dashboard
refreshDatestringISO 8601 timestamp when the dashboard was last refreshed
successbooleanSalesforce operation success

salesforce_query

Execute a custom SOQL query to retrieve data from Salesforce

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
querystringYesSOQL query to execute (e.g., SELECT Id, Name FROM Account LIMIT 10)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectQuery results
recordsarrayArray of sObject records matching the query
querystringThe executed SOQL query
metadataobjectResponse metadata
totalReturnednumberNumber of records returned in this response
hasMorebooleanWhether more records exist (inverse of done)
successbooleanSalesforce operation success

salesforce_query_more

Retrieve additional query results using the nextRecordsUrl from a previous query

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
nextRecordsUrlstringYesThe nextRecordsUrl value from a previous query response (e.g., /services/data/v59.0/query/01g...)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectQuery results
recordsarrayArray of sObject records matching the query
metadataobjectResponse metadata
totalReturnednumberNumber of records returned in this response
hasMorebooleanWhether more records exist (inverse of done)
successbooleanSalesforce operation success

salesforce_describe_object

Get metadata and field information for a Salesforce object

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description
objectNamestringYesSalesforce object API name (e.g., Account, Contact, Lead, Custom_Object__c)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectObject metadata
objectNamestringAPI name of the object (e.g., Account, Contact)
labelstringHuman-readable singular label for the object
labelPluralstringHuman-readable plural label for the object
fieldsarrayArray of field metadata objects
namestringAPI name of the field
labelstringDisplay label of the field
typestringField data type (string, boolean, int, double, date, etc.)
lengthnumberMaximum length for text fields
precisionnumberPrecision for numeric fields
scalenumberScale for numeric fields
nillablebooleanWhether the field can be null
uniquebooleanWhether values must be unique
createablebooleanWhether field can be set on create
updateablebooleanWhether field can be updated
defaultedOnCreatebooleanWhether field has default value on create
calculatedbooleanWhether field is a formula field
autoNumberbooleanWhether field is auto-number
externalIdbooleanWhether field is an external ID
idLookupbooleanWhether field can be used in ID lookup
inlineHelpTextstringHelp text for the field
picklistValuesarrayAvailable picklist values for picklist fields
referenceToarrayObjects this field can reference (for lookup fields)
relationshipNamestringRelationship name for lookup fields
custombooleanWhether this is a custom field
filterablebooleanWhether field can be used in SOQL filter
groupablebooleanWhether field can be used in GROUP BY
sortablebooleanWhether field can be used in ORDER BY
keyPrefixstringThree-character prefix used in record IDs (e.g., "001" for Account)
queryablebooleanWhether the object can be queried via SOQL
createablebooleanWhether records can be created for this object
updateablebooleanWhether records can be updated for this object
deletablebooleanWhether records can be deleted for this object
childRelationshipsarrayArray of child relationship metadata for related objects
recordTypeInfosarrayArray of record type information for the object
fieldCountnumberTotal number of fields on the object
successbooleanSalesforce operation success

salesforce_list_objects

Get a list of all available Salesforce objects

Input

ParameterTypeRequiredDescription
idTokenstringNoNo description
instanceUrlstringNoNo description

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectObjects list
objectsarrayArray of sObject metadata
namestringAPI name of the object
labelstringDisplay label of the object
labelPluralstringPlural display label
keyPrefixstringThree-character ID prefix
custombooleanWhether this is a custom object
queryablebooleanWhether object can be queried
createablebooleanWhether records can be created
updateablebooleanWhether records can be updated
deletablebooleanWhether records can be deleted
searchablebooleanWhether object is searchable
triggerablebooleanWhether triggers are supported
layoutablebooleanWhether page layouts are supported
replicateablebooleanWhether object can be replicated
retrieveablebooleanWhether records can be retrieved
undeletablebooleanWhether records can be undeleted
urlsobjectURLs for accessing object resources
encodingstringCharacter encoding for the organization (e.g., UTF-8)
maxBatchSizenumberMaximum number of records that can be returned in a single query batch (typically 200)
totalReturnednumberNumber of objects returned
successbooleanSalesforce operation success

On this page

Start building today
Trusted by over 60,000 builders.
Build Agentic workflows visually on a drag-and-drop canvas or with natural language.
Get started