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)
Advanced Lookup Display Info
Advanced Lookup Display Info Field
Advanced Lookup Info
Batch Result Item
Canvas Layout Component
Case Status Picklist Value Attributes
Child Relationship
Custom Link Layout Component
Display Layout
Display Layout and Matching Info
Duplicate Record Error
Duplicate Result Info
Duplicate Rule
Duplicate Rule Filter
Duplicate Rule Filter Item
Error Message
Error with Output
Field
Field Layout Component
Field Value
Filtered Lookup Info
Lead Status Picklist Value Attributes
List Column
List Column Inline Edit Attributes
List Filter by Info
List Info Share
List Info Share Category
List Info Summary
List Inline Edit Details
List Object Column
List Object Picklist Value
List Object Quick Filter Overrides
List Object Scope
List Object Scope Available Entity
List Order By Info
List Reference
List Scope
List Scope Entity
List Scope Related Entity
List User Preference
Location Field
Lookup Metadata
Lookup Metadata Target Info
Match
Match Result
Match Result Info
Match Rule
Matching Info
Navigation Item
Object Action
Object Info Directory Entry
Opportunity Stage Picklist Value Attributes
Page Reference
Picklist Value
Platform Action
Record Exceptions
Record Exception Error
Record Layout Component
Record Layout Item
Record Layout Row
Record Layout Save Option
Record Layout Section
Record Layout Section User State
Record Layout User State
Record Template Clone
Record Template Create
Record Type Info
Reference To Info
Related List Column
Related List Info Summary
Related List Reference
Report Layout Component
Theme Banner
Theme Image
Theme Info
Visualforce Layout Component
Work Step Status Picklist Value Attributes
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 Nested Response Bodies
These response bodies are nested in top-level response bodies.
A request to a resource always returns an HTTP status code, whether the request was successful or not.
-
Advanced Lookup Display Info
Search lookups advanced display information. -
Advanced Lookup Display Info Field
Search lookups advanced display field information. -
Advanced Lookup Info
Advanced search lookup information. -
Batch Result Item
The results of one subrequest in a batch request. -
Canvas Layout Component
A canvas component on a record page layout. -
Case Status Picklist Value Attributes
Additional picklist value attributes for case statuses. -
Child Relationship
The child relationship on a parent object. Relationships are connections between records. Use relationships to display data about related object records on a record's detail page. -
Custom Link Layout Component
A custom link component on a record page layout. -
Display Layout
Search lookups target display layout metadata. -
Display Layout and Matching Info
Search lookups target display layout and matching information. -
Duplicate Record Error
Information about duplicate record errors. Duplicate rules are used to control whether and when you can save duplicate records within Salesforce. Duplicate rules tell Salesforce what action to take when you attempt to create a duplicate record. -
Duplicate Result Info
The result of the check for duplicate records. If duplicate records exist, returns the records' IDs and the duplicate rule that was used to match the records. -
Duplicate Rule
Describes a duplicate rule. -
Duplicate Rule Filter
A duplicate rule filter. -
Duplicate Rule Filter Item
A filter, or condition, for a duplicate rule. For example, a condition can specify that this rule applies only to movies that were produced in the United States. -
Error Message
An error code and error message. -
Error with Output
Contains extra information about errors. In rare cases, an error message isn't enough to describe the reason for a failure. For example, when a conflicting precondition exists, the error result can include the information about the cause of the conflict. -
Field
A field's metadata. -
Field Layout Component
A field in a record layout. -
Field Value
The raw and displayable field values for a field in a record. -
Filtered Lookup Info
Metadata for a lookup filter. -
Lead Status Picklist Value Attributes
Additional picklist value attributes for lead statuses. -
List Column
A column in a list. -
List Column Inline Edit Attributes
List column inline edit attributes. -
List Filter by Info
Information used to filter a list. -
List Info Share
List info share. -
List Info Share Category
List info share category. -
List Info Summary
List info summary. -
List Inline Edit Details
List inline edit details. -
List Object Column
List object column. -
List Object Picklist Value
List object picklist value. -
List Object Quick Filter Overrides
List object column quick filter overrides. -
List Object Scope
List object scope. -
List Object Scope Available Entity
List object scope available entity, such as a group or queue. -
List Order By Info
Ordering information for a list. -
List Reference
The list view referenced by the collection or metadata. -
List Scope
List scope. -
List Scope Entity
List scope entity. -
List Scope Related Entity
List scope related entity. -
List User Preference
User preferences for the list view. -
Location Field
A complex location value for a record field. -
Lookup Metadata
Search lookups metadata. -
Lookup Metadata Target Info
Search lookups target metadata. -
Match
A group of records that match the duplicate rules. -
Match Result
A duplicate rule match. Duplicate rules are used to control whether and when you can save duplicate records within Salesforce. Duplicate rules tell Salesforce what action to take when you attempt to create a duplicate record. Each duplicate rule requires at least one matching rule to identify which existing records are possible duplicates. -
Match Result Info
Information about the results of a match. -
Match Rule
A match rule defines how duplicate records are identified in duplicate rules and duplicate jobs. Learn about one of the match rules for the specified object, including the match rule's name and the fields that the match rule checks. -
Matching Info
Search lookups target matching information. -
Navigation Item
The metadata for a single navigation item (tab). -
Object Action
The actions for an object. -
Object Info Directory Entry
An entry in the Object Info Directory, which is a directory of objects that User Interface API supports and that the context user can access. -
Opportunity Stage Picklist Value Attributes
Additional picklist value attributes for opportunity stages. -
Page Reference
A page reference. -
Picklist Value
A single picklist value. -
Platform Action
The metadata, layout information, and data for a platform action. -
Record Exceptions
A collection of record exception errors. -
Record Exception Error
Information about a record exception error. -
Record Layout Component
A concrete record layout component. -
Record Layout Item
An item in a record layout. -
Record Layout Row
A row in a record layout. -
Record Layout Save Option
The save option for a record layout. Save options define behavior that occurs when objects are created or modified using the given layout. For example, for Cases and Leads, a “UseDefaultAssignmentRule” save option is exposed to control whether assignment rules are applied when Cases or Leads are created or edited. -
Record Layout Section
A section in a record layout. -
Record Layout Section User State
The user state information for a record layout section. -
Record Layout User State
The user state information for a record layout. -
Record 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 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 Type Info
Information about a record type. -
Reference To Info
Information about a reference field's referenced types and the name field names of those types. -
Related List Column
A column in a related list. -
Related List Info Summary
A summary of a related list for an object. -
Related List Reference
The related list referenced by the collection or metadata. -
Report Layout Component
A report chart component on a record layout page. -
Theme Banner
A theme banner image. Theme banners have a higher aspect ratio than theme images. The banner size may change slightly, so code accordingly. -
Theme Image
A theme image at three sizes: small, medium, and large. Specific sizes may change slightly, so code accordingly. -
Theme Info
Color and icon information for a theme. -
Visualforce Layout Component
A Visualforce component on a record layout page. -
Work Step Status Picklist Value Attributes
Additional picklist value attributes for work step statuses.