User Interface API Developer Guide
jSummer '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
Favorite
Favorite Collection
List Metadata
List Record Collection
List UI
List View Summary Collection
Lookup Values
Most Recently Used List Metadata
Most Recently Used List Record Collection
Most Recently Used List UI
Navigation Items
Object Info
Object Info Directory
Picklist Values
Picklist Values Collection
Record
Record Collection
Record Defaults
Record Layout
Record UI
Theme
Newer Version Available
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. -
Favorite
A single favorite. -
Favorite Collection
A list of favorites. -
List Metadata
Metadata that describes a list view. -
List Record Collection
A collection of list view records. -
List UI
The record data and metadata for a list view. -
List View Summary Collection
A collection of list views for a given object. -
Lookup Values
Records in a lookup relationship, organized by object type. -
Most Recently Used List Metadata
Metadata that describes a most recently used (MRU) list view. -
Most Recently Used List Record Collection
A collection of an object’s most recently used list view records. -
Most Recently Used List UI
The record data and metadata for an object’s most recently used (MRU) list view. -
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. -
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 Layout
The layout information for a record. -
Record UI
The layout information, field information, and data for a record. -
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.