User Interface API Developer Guide

Get Started with User Interface API
User Interface API Features
User Interface API Resources
Records
Actions
Favorites
List Views
Get List Views for an Object
Get List View Records
Get List View Metadata
Get a Batch of List View Metadata
Get List View Records and Metadata
Get Most Recently Used List View Records
Get Most Recently Used List View Metadata
Get Most Recently Used List View Records and Metadata
Get Related Lists for an Object
Get Related List Records with URL Parameters
Get Related List Records with a Request Body
Get Related List Metadata
Get Related List Record Count
Get a Batch of Related List Metadata
Get a Batch of Related List Records with URL Parameters
Get a Batch of Related List Records with a Request Body
Get a Batch of Related List Record Counts
Update Related List Metadata
Get Related List User Preferences
Get a Batch of Related List User Preferences
Update Related List User Preferences
Apps
Get Active Theme
User Interface API Request Bodies
User Interface API Response Bodies
Supported Objects
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Get a Batch of Related List User Preferences

Returns a batch of user preferences for a related list.
Resource
1/ui-api/related-list-preferences/batch/${preferencesIds}
  • preferencesIds—A comma-delimited set of related list user preference IDs, such as Account.RelatedContactList.
Available Version
57.0
HTTP Method
GET
Example

To get user preferences for the Contact and Opportunity related lists on an Account, make this request.

1GET /services/data/v57.0/ui-api/related-list-preferences/batch/Account.RelatedContactList,Account.RelatedOpportunityList
Response Body
Simplified Batch Results