User Interface API Developer Guide

Get Started with User Interface API
User Interface API Features
User Interface API Resources
Records
Get Record Data and Object Metadata
Get Record Layout Metadata
Get a Directory of Supported Objects
Get Object Metadata
Get a Batch of Object Metadata
Get Values for a Picklist Field
Get Values for All Picklist Fields of a Record Type
Get Child Records
Get a Record
Get a Batch of Records
Create or Clone a Record
Create a Batch of Records
Get Default Values to Clone a Record
Get Default Values to Clone a Record—Lightweight
Get Default Values to Create a Record
Get Default Values to Create a Record—Lightweight
Update a Record
Update a Batch of Records
Delete a Record
Delete a Batch of Records
Get Lookup Field Suggestions With POST
Check for Duplicate Records
Get Duplicate Management Configuration for a Specified Object
Upload a File
Upload a New File Version
Actions
Favorites
Lists
Apps
Get Active Theme
Session CSRF Token
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.

Get Object Metadata

Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme.
Resource
1/ui-api/object-info/{objectApiName}
objectApiName—A supported object.
Available Version
41.0
HTTP Method
GET
Response Body
Object Info