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. 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.

All related lists resources support every object supported by User Interface API.

Note

Supported Objects for List Views

These list views resources support a subset of objects.

/ui-api/list-ui/${objectApiName}
/ui-api/list-info/${listViewId} and /ui-api/list-info/${objectApiName}/${listViewApiName}
/ui-api/list-records/${listViewId} and /ui-api/list-records/${objectApiName}/${listViewApiName}
/ui-api/list-ui/${listViewId} and /ui-api/list-ui/${objectApiName}/${listViewApiName}

Supported Objects for MRU List Views

These MRU list views resources support a subset of objects.

Supported Objects for Related Lists

These examples show information about the related lists associated with an object. If there are no related lists for an object, you see a valid response of zero lists. Related lists resources support all UI API supported objects listed in All Supported Objects.

User Interface API Developer Guide

Supported Objects

See Also