User Interface API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with User Interface API
User Interface API Features
User Interface API Resources
Records
Actions
Favorites
Lists
Get List View Metadata
Get a Batch of List View Metadata
Update List View Metadata
Delete List View Metadata
Get List Views for an Object
Create a List View for an Object
Get Metadata for a List View Object
Get List View Records with URL Parameters
Get List View Records with a Request Body
Get List View Preferences
Update List View Preferences
Get Related Lists for an Object
Get Related List Records with URL Parameters
Get Related List Records with a Request Body
Get Related List Metadata
Get Related List Record Count
Get a Batch of Related List Metadata
Get a Batch of Related List Records with URL Parameters
Get a Batch of Related List Records with a Request Body
Get a Batch of Related List Record Counts
Update Related List Metadata
Get Related List User Preferences
Get a Batch of Related List User Preferences
Update Related List User Preferences
Apps
Get Active Theme
User Interface API Request Bodies
User Interface API Response Bodies
User Interface API Appendices
PDF

Get Related List Records with URL Parameters

Returns record data for up to 1,999 records in a related list via URL parameters.
Resources
/ui-api/related-list-records/${parentRecordId}/${relatedListId}
  • parentRecordId—The ID of the record you want to get related lists for.
  • relatedListId—The API name of a supported related list for that object, such as Contracts. In API version 62.0 and later, relatedListId supports the API name of a child relationship.
Available Version
50.0
HTTP Method
GET
Example
To get metadata for the Contracts related list for the account record 001RM000003UNu6YAG, make this request.
/services/data/v64.0/ui-api/related-list-records/001RM000003UNu6YAG/Contracts
To get metadata for the Contracts related list for the account record 001RM000003UNu6YAG, and also retrieve the ContractNumber field, make this request.
/services/data/v64.0/ui-api/related-list-records/001RM000003UNu6YAG/Contracts?fields=Contract.ContractNumber
Request Parameters

To get record data for a related list without complex URL parameters, you can use the POST method and enter request parameters in the request body. See Get a Related List Records with a Request Body.

Note

Parameter Name Type Description Required or Optional Available Version
fields String[] Fields queried for the records returned. These fields are included in the response body and don’t create visible columns. If the field isn’t available to the user, an error occurs. Optional 50.0
optionalFields String[] Additional fields queried for the records returned. These fields are included in the response body and don’t create visible columns. If the field isn’t available to the user, no error occurs and the field isn’t included in the records. Optional 50.0
pageSize Integer The number of list records viewed at one time. The default value is 50. Value can be 1–1999. Optional 50.0
pageToken String The token for additional pages of records beyond the first page. To fetch another page, use the value returned by nextPageTokenfrom the previous page. Optional 50.0
sortBy String[] The API names of the fields that the related list is sorted by. If the name is preceded with -, the sort order is descending. For example, Name sorts by name in ascending order. -CreatedDate sorts by created date in descending order.

In API version 63.0 and later, you can sort by up to five fields. If a field is invalid or isn’t accessible to the context user, this parameter is ignored, but no error occurs.

 Optional 50.0
where String

The where parameter isn’t supported for GET requests.

Note

 Optional 55.0
Response Body
Related List Record Collection