Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Get List Views for an Object

Get list views associated with an object.

Resource

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

objectApiName—A supported object, such as Account.

Available version

61.0

HTTP methods

GET

Example

This example gets all the list views associated with accounts.

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

This example gets the most recently used list views associated with accounts using the recentListsOnly request parameter.

1GET /services/data/v67.0/ui-api/list-info/Account?recentListsOnly=true

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`pageSize`	Integer	Number of list records viewed at one time. The default value is 20. Value can be 1–2000.	Optional	61.0
`pageToken`	String	Token that represents the page offset. To indicate where the page starts, use this value with the `pageSize` parameter. The maximum offset is 2000 and the default is 0.	Optional	61.0
`q`	String	Search term to filter the results. Wildcards are supported.	Optional	61.0
`recentListsOnly`	Boolean	Indicates whether to get recent lists only (`true`) or not (`false`). Default is `false`.	Optional	61.0

Response body for GET

List Info Summary Collection

User Interface API Developer Guide

Get List Views for an Object