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 List Record Count

Returns the record count for a related list.

Resource

1/ui-api/related-list-count/${parentRecordId}/${relatedListId}

parentRecordId—The ID of the record you want to get related lists for.
relatedListId—The ID of a supported related list for that object.

Available Version

50.0

HTTP Method

GET

Example

To get the number of records in the Contracts related list for the account 001RM000003UNu6YAG, make this request.

1/services/data/v67.0/ui-api/related-list-count/001RM000003UNu6YAG/Contracts

Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`maxCount`	Integer	The maximum number of records to return. The default value is 20.	Optional	50.0

Response Body

Related List Record Count

User Interface API Developer Guide

Get Related List Record Count