Get List View Metadata

Returns 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.

Available version

42.0

HTTP methods

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:

1/services/data/v42.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:

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

The request returns the metadata for the list view.

1{
2  "cloneable" : true,
3  "createable" : true,
4  "deletable" : true,  
5  "displayColumns" : [ {
6    "fieldApiName" : "Name",
7    "label" : "Account Name",
8    "sortable" : true
9  }, {
10    "fieldApiName" : "BillingState",
11    "label" : "Billing State/Province",
12    "sortable" : true
13  }, {
14    "fieldApiName" : "Phone",
15    "label" : "Phone",
16    "sortable" : true
17  }, {
18    "fieldApiName" : "Type",
19    "label" : "Type",
20    "sortable" : true
21  }, {
22    "fieldApiName" : "Owner.Alias",
23    "label" : "Account Owner Alias",
24    "sortable" : true
25  } ],
26  "eTag" : "86d3a33eddb41d9889b38b102c915abf",
27  "filterLogicString" : null,
28  "filteredByInfo" : [ ],
29  "id" : {
30    "id" : "00BR0000000Wc0rMAC",
31    "objectApiName" : "Account",
32    "type" : "listView"
33  },
34  "label" : "All Accounts",
35  "listViewApiName" : "AllAccounts",
36  "orderedByInfo" : [ {
37    "fieldApiName" : "Name",
38    "isAscending" : true,
39    "label" : "Account Name"
40  } ],
41  "updateable" : true,
42  "userPreferences" : {
43    "columnWidths" : {
44      "Type" : -1,
45      "Owner.Alias" : -1,
46      "Phone" : -1,
47      "BillingState" : -1,
48      "Name" : -1
49    },
50    "columnWrap" : {
51      "Type" : false,
52      "Owner.Alias" : false,
53      "Phone" : false,
54      "BillingState" : false,
55      "Name" : false
56    }
57  },
58  "visibility" : "Public",
59  "visibilityEditable" : true
60}

Response body for GET

List Metadata

User Interface API Developer Guide

Get List View Metadata