Get List Views for an Object

Returns a collection of list views associated with an object.

Resource

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

objectApiName—A supported object, such as Account.

Available version

43.0

HTTP methods

GET

Example

To retrieve all list views associated with accounts, make this request:

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

The request returns a list of all list views for the given object.

1{
2    "count" : 6,
3    "currentPageToken" : "0",
4    "currentPageUrl" : "/services/data/v43.0/ui-api/list-ui/Account?pageSize=20&pageToken=0",
5    "eTag" : "d33d58077e8560bcaec18bdc2647c642",
6    "lists" : [ {
7        "apiName" : "AllAccounts",
8        "id" : "00BRM000002KPM42AO",
9        "label" : "All Accounts",
10        "listUiUrl" : "/services/data/v43.0/ui-api/list-ui/Account/AllAccounts"
11    }, {
12        "apiName" : "MyAccounts",
13        "id" : "00BRM000002KPMM2A4",
14        "label" : "My Accounts",
15        "listUiUrl" : "/services/data/v43.0/ui-api/list-ui/Account/MyAccounts"
16    }, {
17        "apiName" : "NewLastWeek",
18        "id" : "00BRM000002KPMj2AO",
19        "label" : "New Last Week",
20        "listUiUrl" : "/services/data/v43.0/ui-api/list-ui/Account/NewLastWeek"
21    }, {
22        "apiName" : "NewThisWeek",
23        "id" : "00BRM000002KPMQ2A4",
24        "label" : "New This Week",
25        "listUiUrl" : "/services/data/v43.0/ui-api/list-ui/Account/NewThisWeek"
26    }, {
27        "apiName" : "PlatinumandGoldSLACustomers",
28        "id" : "00BRM000002KPMg2AO",
29        "label" : "Platinum and Gold SLA Customers",
30        "listUiUrl" : "/services/data/v43.0/ui-api/list-ui/Account/PlatinumandGoldSLACustomers"
31    }, {
32        "apiName" : "RecentlyViewedAccounts",
33        "id" : "00BRM000002KPM22AO",
34        "label" : "Recently Viewed Accounts",
35        "listUiUrl" : "/services/data/v43.0/ui-api/list-ui/Account/RecentlyViewedAccounts"
36    } ],
37    "nextPageToken" : null,
38    "nextPageUrl" : null,
39    "previousPageToken" : null,
40    "previousPageUrl" : null
41}

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`pageSize`	String	The number of list records viewed at one time. The default value is 20. Value can be 1–2000.	Optional	43.0
`pageToken`	String	A 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	43.0
`q`	String	Query list views that contain certain key words.	Optional	43.0
`recentListsOnly`	Boolean	Show only recently viewed lists.	Optional	43.0

Response body for GET

List View Summary Collection

User Interface API Developer Guide

Get List Views for an Object