Welcome to simple-salesforce’s documentation!

Simple Salesforce is a basic Salesforce.com REST API client built for Python 3.9, 3.10, 3.11, 3.12, and 3.13. The goal is to provide a very low-level interface to the REST Resource and APEX API, returning a dictionary of the API JSON response.

You can find out more regarding the format of the results in the Official Salesforce.com REST API Documentation

Contents:

• Examples
• Record Management
• Queries
• Other Options
• Using Apex
• Additional Features
• Bulk API Usage Notes
  • Exception Code “InvalidBatch” with message “Records not processed”
  • Working with an output from Pandas
• Using Bulk 2.0
• CRUD Metadata API Calls
• File Based Metadata API Calls
• Using REST
• Using Tooling API
• Helpful Datetime Resources
• Helpful Pandas Resources
  • Generate list for SFDC Query “IN” operations from a Pandas Dataframe
  • Generate Pandas Dataframe from SFDC API Query (ex.query,query_all)
  • Generate Pandas Dataframe from SFDC API Query (ex.query,query_all) and append related fields from query to data frame
  • Generate Pandas Dataframe from SFDC Bulk API Query (ex.bulk.Account.query)
• YouTube Tutorial
• Development
  • Setting up for Development
  • Running Tests
  • Contributing

API documentation

• simple_salesforce
  • simple_salesforce package
    • Subpackages
    • Submodules
    • Module contents

Release history

• Changes
• v1.12.9
  • Bug fixes
• v1.12.8
  • Bug fixes
  • Other
• v1.12.7
  • Features
  • Bug Fixes
  • Other
• v1.12.6
  • Features
  • Bug Fixes
• v1.12.5
  • Features
• v1.12.4
  • Bug Fixes
  • Other
• v1.12.3
  • Bug Fixes
  • Other
• v1.12.2
  • Features
  • Other
• v1.12.1
  • Bugs
• v1.12.0
  • Features
• v1.11.5
  • Bugs
• v1.11.5
  • Bugs
  • Features
  • Other
• v1.11.4
• v1.11.3
  • Bugs
• v1.11.2
  • Bugs
• v1.11.1
  • Features
  • Bugs
• v1.11.0
• v1.10.1
  • Other
• v1.10.0
  • Features
• v1.0.0
  • Other
• v0.75
  • Features
• v0.72
  • Bugs
• v0.71
  • Features
• v0.70
  • Features
• v0.69
  • Features
  • Other
• v0.68.2
  • Other

Authors & License

This package is released under an open source Apache 2.0 license. Simple-Salesforce was originally written by Nick Catalano but most newer features and bugfixes come from community contributors. Pull requests submitted to the GitHub Repo are highly encouraged!

Authentication mechanisms were adapted from Dave Wingate’s RestForce and licensed under a MIT license

The latest build status can be found at GitHub Actions

Indices and tables

• Index

• Module Index

• Search Page