User Interface API Developer Guide
jNewer Version Available
Work with List Views
Use the List View resources to get record data and metadata about
list views displayed in the Salesforce UI.
- Get Record Data and Metadata for a List View
-
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 and metadata for this list view, make this request.
1/services/data/v60.0/ui-api/list-ui/00BR0000000Wc0rMACYou can also use the object API name and list view API name of the list view to make the same request.
1/services/data/v60.0/ui-api/list-ui/Account/AllAccountsThe request returns a list of records and the metadata for the list view.
- Modify the List View Results
-
To modify the results returned by the List View resources, use the following request parameters:
- fields—Additional fields queried for the records returned, for display purposes. If a field is specified and the user doesn’t have access to it, an error occurs.
- optionalFields—Additional fields queried for the records returned, for display purposes. If a field is specified and the user doesn’t have access to it, no error occurs.
- pageSize—The number of list records viewed at one time.
- pageToken—A token that represents the page offset.
- sortBy—The API name of the field the list view is sorted by.
For example, to sort records by the date they were created, set the sortBy parameter to CreatedDate.
1GET /services/data/v60.0/ui-api/list-ui/00BR0000000Wc0rMAC?sortBy=CreatedDate