Get a Batch of Related List Metadata

Returns metadata for a batch of related lists.

Resource

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

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

Available version

50.0

HTTP methods

GET

Example

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

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

Request parameters for GET

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 for GET

Simplified Batch Results

User Interface API Developer Guide