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

To get metadata for the Contracts related list in the Account object, make this request.

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

Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`fields`	String[]	Fields in the related list to query. If a field is specified and the user doesn’t have access to it or it doesn’t exist, an error occurs.	Optional	57.0
`optionalFields`	String[]	Additional fields in the related list to query. If a field is specified and the user doesn’t have access to it, no error occurs.	Optional	57.0
`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
`restrictColumnsToLayout`	Boolean	Indicates whether to retrieve metadata for only the list columns in the page layout (`true`) or all columns (`false`). The default value is true. To further filter columns, also use `fields` and `optionalFields`.	Optional	57.0

Response Body

Related List Info

User Interface API Developer Guide