Getting Started

Use this section to go from a fresh install to your first successful Salesforce API call with salespyforce.

If you are new to the library, follow this order:

1. Read Overview for requirements and capabilities.

2. Complete Installation to install the package.

3. Work through Quickstart for a first end-to-end example.

Before you begin, make sure you have:

• Python 3.9+

• Access to a Salesforce org

• A Salesforce user with API permissions

• Connected App credentials (client key/secret) and security token as needed

Important

SalesPyForce 1.5.0 is the final release that supports Python 3.9, 3.10, and 3.11.

SalesPyForce 2.0.0 and newer will require Python 3.12 or newer.

For deeper task-based walkthroughs after setup, continue to the Guides section. For method and exception details, see the Reference section.