REST API Developer Guide
jWinter '27 preview (API version 68.0)
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Spring '14 (API version 30.0)
Delete Lightning Experience Event Series
Get an Image from a Rich Text Area Field
Insert or Update Blob Data
Get Blob Data
Generating an OpenAPI 3.0 Document for sObjects REST API (Beta)
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.
Examples
This section provides examples of using REST API resources to do a variety of different tasks, including working with objects, organization information, and queries.
For complete reference information on REST API resources, see Reference.
-
Getting Information About My Organization
The examples in this section use REST API resources to retrieve organization-level information, such as a list of all objects available in your organization. -
Working with Object Metadata
The examples in this section use REST API resources to retrieve object metadata information. For modifying or creating object metadata information, see the Metadata API Developer Guide. -
Working with Records
The examples in this section use REST API resources to create, retrieve, update, and delete records, along with other record-related operations. -
Delete Lightning Experience Event Series
Use the HTTP DELETE method to remove one or more IsRecurrence2 events in a series. You can remove a single event, all events following and including a specific event, or an entire event series. -
Working with Searches and Queries
The examples in this section use REST API resources to search and query records using Salesforce Object Search Language (SOSL) and Salesforce Object Query Language (SOQL), and other search APIs. -
Get an Image from a Rich Text Area Field
Use the sObject Rich Text Image Get resource to retrieve an image from a rich text area field. In this example, we retrieve an image from a custom rich text field of a Lead record called LeadPhotoRichText__c. We assume that an image has already been uploaded to this field. -
Insert or Update Blob Data
You can use the sObject Basic Information, sObject Rows, or sObject Collections resources to insert or update binary large objects (blobs) in Salesforce, such as images or PDFs. You can upload files or binary data of any type to any standard object that contains a blob field. -
Get Blob Data
Use the sObject Blob Get resource to get blob data for a given record. To get blob data, a record with blob data must exist in Salesforce. -
Working with Recently Viewed Information
The examples in this section use REST API Query and Recently Viewed resources to programmatically retrieve and update recently viewed record information. -
Managing User Passwords
The examples in this section use REST API resources to manage user passwords, such as setting or resetting passwords. -
Working with Approval Processes and Process Rules
The examples in this section use REST API resources to work with approval processes and process rules. -
Using Event Monitoring
These examples use REST API event monitoring data that contains information useful for assessing org usage trends and user behavior. Event monitoring is accessed through the Lightning Platform SOAP API and REST API by way of the EventLogFile object. Therefore, you can integrate log data with your own back-end storage and data marts to correlate data from multiple orgs and across disparate systems. -
Using Composite Resources
The examples in this section use composite resources to improve your application’s performance by minimizing the number of round-trips between the client and server.