Retrieve Records Using sObject Relationships

Retrieves a record based on the specified object, record ID, and relationship field. The fields and field values of the record are returned in the response body. If there are multiple related records, you can retrieve the complete set of associated records

URI

/services/data/vXX.X/sobjects/sObject/id/relationship_field_name

Formats

JSON, XML

HTTP Method

GET

Authentication

Authorization: Bearer token

Parameters

Parameter	Description
sObject	The name of the object. For example, `Account`.
id	The identifier of the record. For example, `001R0000005hDFYIA2`.
relationship_field_name	The name of the field that contains the relationship. For example, `Opportunities`.
fields	Optional for GET. A comma-delimited list of fields in the associated relationship record returned in the response body. For example: `1/services/data/v56.0/sobjects/sObject/id/relationship field?fields=field1,field2`

Response Body

The response body is the contents of the record associated with the relationship field. Here’s an example of a request and JSON response body for a simple relationship traversal that returns the Distributor__c record associated with a relationship field on custom object Merchandise__c.

1https://MyDomainName.my.salesforce.com/services/data/v56.0/sobjects/Merchandise__c/a01D000000INjVe/Distributor__r

1{
2    "attributes" : 
3    { 
4        "type" : "Distributor__c",
5        "url" : "/services/data/v56.0/sobjects/Distributor__c/a03D0000003DUhcIAG"
6    },
7    "Id" : "a03D0000003DUhcIAG",
8    "OwnerId" : "005D0000001KyEIIA0",
9    "IsDeleted" : false,
10    "Name" : "Distributor1",
11    "CreatedDate" : "2011-12-16T17:43:01.000+0000",
12    "CreatedById" : "005D0000001KyEIIA0",
13    "LastModifiedDate" : "2011-12-16T17:43:01.000+0000",
14    "LastModifiedById" : "005D0000001KyEIIA0",
15    "SystemModstamp" : "2011-12-16T17:43:01.000+0000",
16    "Location__c" : "San Francisco"
17}

Error Responses

If there’s no record associated with a relationship field, a 404 error response is returned. If the relationship field normally resolves to multiple records and no relationship set exists, a 200 response is returned. If the fields parameter is used with fields that don’t exist or aren’t visible to the consumer by field-level security, a 400 error response is returned. For other error messages, see Status Codes and Error Responses.

Examples

For examples of using sObject Relationships to access relationship fields, see Traverse Relationships with Friendly URLs.

REST API Developer Guide

Retrieve Records Using sObject Relationships

See Also