User Interface API Developer Guide

Get Started with User Interface API
User Interface API Features
User Interface API Resources
Records
Actions
Favorites
List Views
Get List Views for an Object
Get List View Records
Get List View Metadata
Get List View Records and Metadata
Get Most Recently Used List View Records
Get Most Recently Used List View Metadata
Get Most Recently Used List View Records and Metadata
Get Related Lists for an Object
Get Related List Records
Get Related List Metadata
Get Related List Record Count
Get a Batch of Related List Metadata
Get a Batch of Related List Records
Get a Batch of Related List Record Counts
Update Related List Metadata
Apps
Get Active Theme
User Interface API Request Bodies
User Interface API Response Bodies
Supported Objects
PDF

Newer Version Available

This content describes an older version of this product. View Latest

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 methods
GET
Example

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

1GET /services/data/v53.0/ui-api/related-list-info/Account
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
Related List Summary Collection