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.

Supported Objects

User Interface API supports all custom objects and external objects and many standard objects.

To get a directory of objects that are supported by the API and accessible to the context user, use the /ui-api/object-info resource.

To understand how the API operates on supported objects, let’s look at some examples.

This resource gets object metadata. It operates on any supported object.

1GET /ui-api/object-info/{objectApiName}

This example gets Account metadata.

1GET /ui-api/object-info/Account

This resource gets record data and metadata. It operates on any supported object record.

1GET /ui-api/record-ui/{recordIds}

This example gets data and metadata to display an Opportunity record.

1GET /ui-api/record-ui/006RM000002XCd1YAG

Most User Interface API resources support these objects. Related lists resources support every object supported by User Interface API. The list views and most recently used list views resources support smaller sets of objects. For a list of all supported objects, see All Supported Objects.

User Interface API Developer Guide

Supported Objects

See Also