User Interface 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)
Action
App
Apps
Batch Results
Content Document Composite
CSRF Token
Duplicates
Duplicates Configuration
Favorite
Favorite Collection
List Info
List Info Summary Collection
List Object Info
List Preferences
List Record Collection
Lookup Values
Navigation Items
Object Info
Object Info Directory
Picklist Values
Picklist Values Collection
Quick Action Execution
Quick Action Layout
Record
Record Collection
Record Defaults
Record Defaults Template Clone
Record Defaults Template Create
Record Layout
Record UI
Related List Info
Related List Info Summary Collection
Related List Record Collection
Related List Record Count
Related List User Preferences
Simplified Batch Results
Theme
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.
User Interface API Top-Level Response Bodies
These response bodies are returned from requests to User Interface API resources. They
may contain nested response bodies
A request to a resource always returns an HTTP response code, whether the request was successful or not.
-
Action
The actions for a single record or a collection of records. -
App
The metadata for a single app. -
Apps
A list of apps that the current user has access to. -
Batch Results
The results from a request to a batch resource. Results include information for each subrequest in the batch. -
Content Document Composite
The file and its relationship to a record. -
CSRF Token
Cross-Site Request Forgery (CSRF) token. -
Duplicates
The results of a check for duplicate records. -
Duplicates Configuration
Contains information about duplicate management configuration for an object. Learn whether duplicate management is configured, which fields are used to determine whether duplicate records exist, and which duplicate rules are active. -
Favorite
A single favorite. -
Favorite Collection
A list of favorites. -
List Info
Metadata that describes a list. -
List Info Summary Collection
List info summary collection. -
List Object Info
List object info. -
List Preferences
List preferences. -
List Record Collection
A collection of list view records. -
Lookup Values
Records, organized by object type, and metadata in a lookup relationship. -
Navigation Items
An ordered list of navigation items (tabs) for the current user. -
Object Info
The metadata for an object. -
Object Info Directory
A directory of objects that are supported by User Interface API and available to the context user. -
Picklist Values
The picklist values for a field, scoped to a record type. If a picklist is dependent, this response includes the values of its immediate controlling field and how they map to the picklist. -
Picklist Values Collection
A collection of picklist values for all the picklists of a specified record type. -
Quick Action Execution
The results that are returned when a quick action executes. -
Quick Action Layout
The record layout used by the quick action. -
Record
The field data, API name, child relationship data, and record type information for a record. -
Record Collection
A paginated collection of Record response bodies. -
Record Defaults
The default information and data needed to create or clone a record. Use these values in a request to POST /ui-api/records. -
Record Defaults Template Clone
A record template containing the default information and data needed to clone a record. Use these values in a request to POST /ui-api/records. -
Record Defaults Template Create
A record template containing the default information and data needed to create a record. Use these values in a request to POST /ui-api/records. -
Record Layout
The layout information for a record. -
Record UI
The layout information, field information, and data for a record. -
Related List Info
Metadata that describes a related list. -
Related List Info Summary Collection
A collection of related lists for a given object. -
Related List Record Collection
A collection of related list records. -
Related List Record Count
The number of records in a given related list. -
Related List User Preferences
User preferences for a related list. -
Simplified Batch Results
The simplified results from a request to a batch resource. Results include information for each subrequest in the batch. -
Theme
A set of images and banners that make up a theme. Banners display across the top of a page and have a higher aspect ratio than images.