User Interface API Developer Guide

Get Started with User Interface API
User Interface API Release Notes
User Interface API Quick Start
User Interface API Sample Apps
Authentication, Versioning, Limits, ETag, and More
Status Codes and Error Responses
API End-of-Life Policy
User Interface API Features
User Interface API Resources
User Interface API Request Bodies
User Interface API Response Bodies
User Interface API Appendices
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.

API End-of-Life Policy

Salesforce is committed to supporting each API version for a minimum of three years from the date of first release. To mature and improve the quality and performance of the API, versions that are more than three years old sometimes are no longer supported.

Salesforce notifies customers who use an API version scheduled for deprecation at least one year before support for the version ends.

Salesforce API Versions Version Support Status Version Retirement Info
Versions 31.0 through 67.0 Supported. Salesforce Platform API Versions 31.0 through 40.0 Retirement
Versions 21.0 through 30.0 As of Summer ’25, these versions are retired and unavailable. Salesforce Platform API Versions 21.0 through 30.0 Retirement
Versions 7.0 through 20.0 As of Summer ’22, these versions are retired and unavailable. Salesforce Platform API Versions 7.0 through 20.0 Retirement

If you request any resource or use an operation from a retired API version, REST API returns the 410:GONE error code.

To identify requests made from old or unsupported API versions, use the API Total Usage event type.