GET /api/v1/profile/{dataModelName}/{Id}/{childDataModelName}
Retrieves related child records for a specific profile record. This endpoint allows you to access hierarchical data through parent-child relationships.
- HTTP Method: GET
- Availability: Data Cloud v1.0, Salesforce v51.0
- format: REST
- URI:
/api/v1/profile/{dataModelName}/{Id}/{childDataModelName}
Parameter | Type | Description |
---|---|---|
dataModelName | string | Required. The unique identifier of the parent data model object. Example: Individual__dlm |
Id | string | Required. The unique identifier of the parent record. Example: 123 |
childDataModelName | string | Required. The unique identifier of the child data model object. Example: ContactPointEmail__dlm |
Parameter | Type | Description |
---|---|---|
fields | string | Comma-separated list of fields to include in the response. Example: Email__c,IsPrimary__c |
limit | integer | Maximum number of records to return. Default: 49,999. Example: 1000 |
offset | integer | Number of records to skip before returning results. Example: 100 |
orderby | string | Field to sort results by. Use - prefix for descending order. Example: Email__c,-IsPrimary__c |
searchkey | string | Field to search by. Example: Email__c |
The response includes:
data
: Array of child record objects containing the requested datadone
: boolean indicating if all results have been returned
- You must explicitly specify fields to retrieve more than 10 fields
- The parent record ID must be a valid identifier
- The child data model must have a valid relationship with the parent
- The response is limited to 49,999 records per request
- Use pagination (limit/offset) for retrieving large datasets