REST API Developer Guide

Introduction to REST API
About REST API
Release Notes
Supported Editions and Required Permissions
REST Resources and Requests
REST API Architecture
Authorization Through External Client Apps or Connected Apps and OAuth 2.0
Headers
Send REST Requests with cURL
Valid Date and DateTime Formats
Status Codes and Error Responses
API End-of-Life Policy
Quick Start
Examples
Generating an OpenAPI 3.0 Document for sObjects REST API (Beta)
Reference
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Supported Editions and Required Permissions

To access your Salesforce org and data using the Salesforce API, you need both an org and a user with API access enabled. There’s more than one Salesforce Edition that supports API access and multiple ways to grant API permission to a user.

Supported Editions for API Access

API access is enabled by default in Enterprise, Performance, Unlimited, and Developer Edition orgs. Professional Edition orgs can add API access as an add-on. For more information, visit Salesforce Help: Add Products and Licenses with the Your Account App or contact a Salesforce account executive.

If you send an API request to an org without API access, Salesforce returns a API_DISABLED_FOR_ORG error.

To protect the configuration and live data in your production org, we recommend using an isolated environment for active development and testing, such as aDeveloper Edition org, sandbox, or scratch org. When ready, you can move successful changes into your production org.

API User Permissions

To make any API call, a user must have the API Enabled permission turned on in the user profile they’re assigned. This permission is enabled by default on some profiles, including many profiles available in Developer Edition orgs. In supported editions, you can also use the Salesforce Integration user license to grant system-to-system integration users full org access while limiting them to API-only operations. For more information, see Salesforce Help: Give Integration Users API Only Access