Supported Objects

User Interface API supports all custom 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

Supported Objects

Most User Interface API resources support these objects. The list views and most recently used (MRU) list views resources support a smaller set of objects.

Supported objects:

Supported Objects for List Views

The list views resources support a subset of objects.

List views resources:

/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 list views resources:

Supported Objects for MRU List Views

The MRU list views resources support a subset of objects.

MRU list views resources:

Supported objects for MRU list views resources:

User Interface API Developer Guide