Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Get a Batch of Related List Metadata

Returns metadata for a batch of related lists in a page layout.

Resource

1/ui-api/related-list-info/batch/${parentObjectApiName}/${relatedListNames}

parentObjectApiName—A supported object, such as Account.
relatedListNames—Comma-separated IDs of supported related lists for that object.

Available Version

50.0

HTTP Method

GET

Example

To get information about the Contracts and Work Orders related lists for the Account object, make this request.

1GET /services/data/v67.0/ui-api/related-list-info/batch/Account/Contracts,WorkOrders

Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`recordTypeId`	Id	The ID of the record type (RecordType object) for the record. If not provided, the default record type is used.	Optional	50.0

Response Body

Simplified Batch Results

User Interface API Developer Guide

Get a Batch of Related List Metadata