REST API Developer Guide

Introduction to REST API
Quick Start
Examples
Getting Information About My Organization
Working with Object Metadata
Working with Records
Create a Record
Update a Record
Delete a Record
Get Field Values from a Standard Object Record
Get Field Values from an External Object Record by Using the Salesforce ID
Get Field Values from an External Object Record by Using the External ID Standard Field
Get a Record Using an External ID
Insert or Update (Upsert) a Record Using an External ID
Traverse Relationships with Friendly URLs
Get a List of Deleted Records Within a Given Timeframe
Get a List of Updated Records Within a Given Timeframe
Delete Lightning Experience Event Series
Working with Searches and Queries
Get an Image from a Rich Text Area Field
Insert or Update Blob Data
Get Blob Data
Working with Recently Viewed Information
Managing User Passwords
Working with Approval Processes and Process Rules
Using Event Monitoring
Using Composite Resources
Generating an OpenAPI 3.0 Document for sObjects REST API (Beta)
Reference
PDF

Get Field Values from an External Object Record by Using the External ID Standard Field

You use the sObject Rows resource to retrieve field values from a record. Specify the fields you want to retrieve in the fields parameter and use the GET method of the resource.

In the following example, the Country__c custom field is retrieved from an external object. Notice that the id (CACTU) isn’t a Salesforce ID. Instead, it’s the External ID standard field of the external object.

Example for retrieving values from fields on the Customer external object
1curl https://MyDomainName.my.salesforce.com/services/data/v67.0/sobjects/Customer__x/CACTU?fields=Country__c -H "Authorization: Bearer token"
Example request body
None required
Example response body
1{
2  "attributes" : {
3    "type" : "Customer__x",
4    "url" : "/services/data/v67.0/sobjects/Customer__x/CACTU"
5  },
6  "Country__c" : "Argentina",
7  "ExternalId" : "CACTU"
8}