Get List View Metadata

Get list view metadata.

Resource

1/ui-api/list-info/${listViewId}

1/ui-api/list-info/${objectApiName}/${listViewApiName}

listViewId—The ID of a list view, such as 00BR0000000Wc0rMAC.
objectApiName—A supported object, such as Account.
listViewApiName—The API name of a list view, such as AllAccounts, __Recent, or __SearchResult.

Available Version

42.0

HTTP Method

GET

Example

As an example, let’s say we have a list view named All Accounts with a list view ID of 00BR0000000Wc0rMAC. To get information about the metadata for this list view, make this request:

1GET /services/data/v63.0/ui-api/list-info/00BR0000000Wc0rMAC

You can also use the object API name and list view API name of the list view to make the same request:

1GET /services/data/v63.0/ui-api/list-info/Account/AllAccounts

To get the most recently used (MRU) list view metadata for accounts, use the special __Recent list view API name.

1GET /services/data/v63.0/ui-api/list-info/Account/__Recent

To get the search layout list view metadata for accounts, use the special __SearchResult list view API name.

1GET /services/data/v63.0/ui-api/list-info/Account/__SearchResult

Response Body

List Info

User Interface API Developer Guide

Get List View Metadata