UI List API

lightning/uiListApi

Get the records and metadata for a list view.

For Use In

Lightning Experience, Experience Builder Sites, Salesforce Mobile App

The lightning/uiListApi (Deprecated) module provides the getListUi wire adapter. getListUi gets list view records and metadata for a list view by:

  • List view API name
  • List view ID
  • API name of supported object

You can also get list view records and metadata for a most recently used list view by object. For this module’s specification and examples, see the Lightning Web Components Developer Guide.

error fallback image
No specifications to show
No specifications are available for this component or API module. When specifications are defined, they'll appear here.