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 Related Lists for an Object

Returns the related lists in an object’s default layout.

Resource

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

parentObjectApiName—A supported object, such as Account.

Available Version

50.0

HTTP Method

GET

Example

To get information about related lists for the Account object, make this request:

1GET /services/data/v67.0/ui-api/related-list-info/Account

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

Related List Summary Collection

User Interface API Developer Guide

Get Related Lists for an Object