---
schema_version: "1"
id: ed26705f8d55ef0236f8dbec75abe81ee89119d013ecd23a18203230bcdce380
title: UI Lists API
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/lightning-base-components/lightning-design-system/guides/lwc/components/lightning/uiListsApi/lightning-ui-lists-api.md
canonical_url: https://developer.salesforce.com/docs/platform/lightning-component-reference/guide/lightning-ui-lists-api.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 1afc46fb28b248c2b81a08742ff45361f9671c9cea86cdc6305e4af1270c5c77
products:
  - Lightning Component Reference
---
# UI Lists API

**`lightning/uiListsApi`**

Get the metadata for a list view.

**For Use In**

Lightning Experience, Experience Builder Sites, Salesforce Mobile App

::::::tabset{tabs='[ "Develop", "Specifications" ]'}

:::::tab
The `lightning/uiListsApi` module includes wire adapters to execute actions on a list view using its API name, such as get a list view’s metadata and record data; create, update, and delete list views; and get and update a list view’s preferences. This module additionally includes adapters to get lists-specific metadata for a given entity using the entity’s API name. The wire adapters are:

- createListInfo
- deleteListInfo
- getListInfoByName
- getListInfosByName
- getListInfosByObjectName
- getListObjectInfo
- getListPreferences
- getListRecordsByName
- updateListInfoByName
- updateListPreferences

For this module's specification and examples, see the [Lightning Web Components Developer Guide](https://developer.salesforce.com/docs/platform/lwc/guide/reference-lightning-ui-api-lists-ui).

## LWC Recipes

The [LWC Recipes GitHub repository](https://github.com/trailheadapps/lwc-recipes) contains code examples for Lightning Web Components that you can test in an org.

For a recipe that uses `lightning/uiListsApi`, see the `c-wire-list-info-by-name` component in the LWC Recipes repo.

:::::

:::::tab
::component-specification{component="uiListsApi" model="lwc" namespace="lightning"}

:::::

::::::