Get List View Records | User Interface API Developer Guide

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

1/ui-api/list-records/${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.

42.0

GET

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 all the records on this list view, make this request:

1/services/data/v43.0/ui-api/list-records/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/v43.0/ui-api/list-records/Account/AllAccounts

The request returns a list of records on the list view.

1{
2  "count" : 12,
3  "currentPageToken" : "0",
4  "currentPageUrl" : "/services/data/v43.0/ui-api/list-records/Account/AllAccounts?pageSize=50&pageToken=0",
5  "listInfoETag" : "f5f522aef88a0cb38be54b9c0095fe3c",
6  "nextPageToken" : null,
7  "nextPageUrl" : null,
8  "previousPageToken" : null,
9  "previousPageUrl" : null,
10  "records" : [ {
11    "apiName" : "Account",
12    "childRelationships" : { },
13    "eTag" : "d55bcd780f2145b724be5a563f37b9b2",
14    "fields" : {
15      "BillingState" : {
16        "displayValue" : null,
17        "value" : "NC"
18      },
19      "CreatedDate" : {
20        "displayValue" : null,
21        "value" : "2018-04-11T00:37:56.000Z"
22      },
23      "Id" : {
24        "displayValue" : null,
25        "value" : "001RM000003UNtxYAG"
26      },
27      "LastModifiedDate" : {
28        "displayValue" : null,
29        "value" : "2018-04-11T00:37:56.000Z"
30      },
31      "Name" : {
32        "displayValue" : null,
33        "value" : "Burlington Textiles Corp of America"
34      },
35      "Owner" : {
36        "displayValue" : null,
37        "value" : {
38          "apiName" : "User",
39          "childRelationships" : { },
40          "eTag" : "671bc4877d13cd4f43d28a671636f873",
41          "fields" : {
42            "Alias" : {
43              "displayValue" : null,
44              "value" : "AUser"
45            },
46            "Id" : {
47              "displayValue" : null,
48              "value" : "005RM000001cNuJYAU"
49            }
50          },
51          "id" : "005RM000001cNuJYAU",
52          "recordTypeInfo" : null
53        }
54      },
55      "OwnerId" : {
56        "displayValue" : null,
57        "value" : "005RM000001cNuJYAU"
58      },
59      "Phone" : {
60        "displayValue" : null,
61        "value" : "(336) 222-7000"
62      },
63      "Site" : {
64        "displayValue" : null,
65        "value" : null
66      },
67      "SystemModstamp" : {
68        "displayValue" : null,
69        "value" : "2018-04-11T00:37:56.000Z"
70      },
71      "Type" : {
72        "displayValue" : "Customer - Direct",
73        "value" : "Customer - Direct"
74      }
75    },
76    "id" : "001RM000003UNtxYAG",
77    "recordTypeInfo" : null
78  }, {
79    "apiName" : "Account",
80    "childRelationships" : { },
81    "eTag" : "e697d1805461f30a76a6d32164bbb930",
82    "fields" : {
83      "BillingState" : {
84        "displayValue" : null,
85        "value" : "KS"
86      },
87      "CreatedDate" : {
88        "displayValue" : null,
89        "value" : "2018-04-11T00:37:56.000Z"
90      },
91      "Id" : {
92        "displayValue" : null,
93        "value" : "001RM000003UNtzYAG"
94      },
95      "LastModifiedDate" : {
96        "displayValue" : null,
97        "value" : "2018-04-11T00:37:56.000Z"
98      },
99      "Name" : {
100        "displayValue" : null,
101        "value" : "Dickenson plc"
102      },
103      "Owner" : {
104        "displayValue" : null,
105        "value" : {
106          "apiName" : "User",
107          "childRelationships" : { },
108          "eTag" : "671bc4877d13cd4f43d28a671636f873",
109          "fields" : {
110            "Alias" : {
111              "displayValue" : null,
112              "value" : "AUser"
113            },
114            "Id" : {
115              "displayValue" : null,
116              "value" : "005RM000001cNuJYAU"
117            }
118          },
119          "id" : "005RM000001cNuJYAU",
120          "recordTypeInfo" : null
121        }
122      },
123      "OwnerId" : {
124        "displayValue" : null,
125        "value" : "005RM000001cNuJYAU"
126      },
127      "Phone" : {
128        "displayValue" : null,
129        "value" : "(785) 241-6200"
130      },
131      "Site" : {
132        "displayValue" : null,
133        "value" : null
134      },
135      "SystemModstamp" : {
136        "displayValue" : null,
137        "value" : "2018-04-11T00:37:56.000Z"
138      },
139      "Type" : {
140        "displayValue" : "Customer - Channel",
141        "value" : "Customer - Channel"
142      }
143    },
144    "id" : "001RM000003UNtzYAG",
145    "recordTypeInfo" : null
146  }, {
147    ... Additional records removed for brevity ...
148    ]
149  }
150}

Parameter Name	Type	Description	Required or Optional	Available Version
`fields`	String[]	Additional fields queried for the records returned. These fields don’t create visible columns. If the field is not available to the user, an error occurs.	Optional	42.0
`optionalFields`	String[]	Additional fields queried for the records returned. These fields don’t create visible columns. If the field is not available to the user, no error occurs and the field isn’t included in the records.	Optional	42.0
`pageSize`	String	The number of list records viewed at one time. The default value is 50. Value can be 1–2000.	Optional	42.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	42.0
`sortBy`	String	The API name of the field the list view is sorted by. If the name is preceded with “-”, the sort order is descending. For example, "Name" sorts by name in ascending order. "-CreatedDate" sorts by created date in descending order.	Optional	42.0

List Record Collection