Get Related List Metadata

Returns metadata for a related list in a page layout.

Resource

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

parentObjectApiName—A supported object, such as Account.
relatedListId—The ID of a supported related list for that object, such as Contracts.

Available Version

50.0

HTTP Method

GET

Example

As an example, if you want to get metadata for the Contracts related list in the Account object, make this request:

1/services/data/v56.0/ui-api/related-list-info/Account/Contracts

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 Info

User Interface API Developer Guide