List Views

Returns the list of list views for the specified sObject, including the ID and other basic information about each list view. You can also get basic information for a specific list view by ID.

This resource is available in REST API version 32.0 and later.

URI: Get a list of list views:; /services/data/vXX.X/sobjects/sobjectType/listviews; Get basic information about one list view:; /services/data/vXX.X/sobjects/sobjectType/listviews/listViewID
Available since release: 31.0
Formats: JSON, XML
HTTP Methods: GET
Authentication: Authorization: Bearer token
Parameters: None

Example

Retrieving a list of list views for the Account object

1curl https://MyDomainName.my.salesforce.com/services/data/v54.0/sobjects/Account/listviews -H "Authorization: Bearer token"

JSON Response body

1{
2  "done" : true,
3  "listviews" : [ {
4    "describeUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcBeMAK/describe",
5    "developerName" : "NewThisWeek",
6    "id" : "00BD0000005WcBeMAK",
7    "label" : "New This Week",
8    "resultsUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcBeMAK/results",
9    "soqlCompatible" : true,
10    "url" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcBeMAK"
11  }, {
12    "describeUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcBpMAK/describe",
13    "developerName" : "NewLastWeek",
14    "id" : "00BD0000005WcBpMAK",
15    "label" : "New Last Week",
16    "resultsUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcBpMAK/results",
17    "soqlCompatible" : true,
18    "url" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcBpMAK"
19  }, {
20    "describeUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcC6MAK/describe",
21    "developerName" : "PlatinumandGoldSLACustomers",
22    "id" : "00BD0000005WcC6MAK",
23    "label" : "Platinum and Gold SLA Customers",
24    "resultsUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcC6MAK/results",
25    "soqlCompatible" : true,
26    "url" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcC6MAK"
27  }, {
28    "describeUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcCEMA0/describe",
29    "developerName" : "RecentlyViewedAccounts",
30    "id" : "00BD0000005WcCEMA0",
31    "label" : "Recently Viewed Accounts",
32    "resultsUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcCEMA0/results",
33    "soqlCompatible" : true,
34    "url" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcCEMA0"
35  }, {
36    "describeUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcCFMA0/describe",
37    "developerName" : "AllAccounts",
38    "id" : "00BD0000005WcCFMA0",
39    "label" : "All Accounts",
40    "resultsUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcCFMA0/results",
41    "soqlCompatible" : true,
42    "url" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcCFMA0"
43  }, {
44    "describeUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcCNMA0/describe",
45    "developerName" : "MyAccounts",
46    "id" : "00BD0000005WcCNMA0",
47    "label" : "My Accounts",
48    "resultsUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcCNMA0/results",
49    "soqlCompatible" : true,
50    "url" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcCNMA0"
51  } ],
52  "nextRecordsUrl" : null,
53  "size" : 6,
54  "sobjectType" : "Account"
55}

Retrieving basic information about one list view

Use the ID of a list view to get basic information about a specific list view.

1curl https://MyDomainName.my.salesforce.com/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcBeMAK -H "Authorization: Bearer token"

JSON Response body

1{
2  "describeUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcBeMAK/describe",
3  "developerName" : "NewThisWeek",
4  "id" : "00BD0000005WcBeMAK",
5  "label" : "New This Week",
6  "resultsUrl" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcBeMAK/results",
7  "soqlCompatible" : true,
8  "url" : "/services/data/v54.0/sobjects/Account/listviews/00BD0000005WcBeMAK"
9}

REST API Developer Guide

List Views

Example