Get List View for an Object

GET {{_endpoint}}/services/data/v{{version}}/ui-api/list-ui/:SOBJECT_API_NAME

Returns a collection of list views associated with an object.

Request Params

KeyDatatypeRequiredDescription
pageSizenullThe number of list records viewed at one time. The default value is 20. Value can be 1–2000.
pageTokennullA 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.
qnullQuery list views that contain certain key words.
recentListsOnlybooleanShow only recently viewed lists.

RESPONSES

status: OK

{"count":6,"currentPageToken":"0","currentPageUrl":"/services/data/v58.0/ui-api/list-ui/Account?pageSize=20\u0026pageToken=0","eTag":"7a9cf6dc597cbc985bab8a26df2f1752","lists":[{"apiName":"AllAccounts","id":"00B58000002ssinEAA","label":"All Accounts","listUiUrl":"/services/data/v58.0/ui-api/list-ui/Account/AllAccounts"},{"apiName":"MyAccounts","id":"00B58000002ssivEAA","label":"My Accounts","listUiUrl":"/services/data/v58.0/ui-api/list-ui/Account/MyAccounts"},{"apiName":"NewLastWeek","id":"00B58000002ssiHEAQ","label":"New Last Week","listUiUrl":"/services/data/v58.0/ui-api/list-ui/Account/NewLastWeek"},{"apiName":"NewThisWeek","id":"00B58000002ssi6EAA","label":"New This Week","listUiUrl":"/services/data/v58.0/ui-api/list-ui/Account/NewThisWeek"},{"apiName":"PlatinumandGoldSLACustomers","id":"00B58000002ssiXEAQ","label":"Platinum and Gold SLA Customers","listUiUrl":"/services/data/v58.0/ui-api/list-ui/Account/PlatinumandGoldSLACustomers"},{"apiName":"RecentlyViewedAccounts","id":"00B58000002ssimEAA","label":"Recently Viewed Accounts","listUiUrl":"/services/data/v58.0/ui-api/list-ui/Account/RecentlyViewedAccounts"}],"nextPageToken":null,"nextPageUrl":null,"objectApiName":"Account","pageSize":20,"previousPageToken":null,"previousPageUrl":null,"queryString":null,"recentListsOnly":false}