sObject Rich Text Image Retrieve

Retrieves the specified image data from a specific rich text area field in a given record. To retrieve an image, you must have a record with an image uploaded to a rich text area field.

URI

/services/data/vXX.X/sobjects/sObject/id/richTextImageFields/fieldName/contentReferenceId

Formats

PNG or JPEG binary image data.

HTTP Method

GET

Authentication

Authorization: Bearer token

Parameters

Parameter	Description
sObjectName	Indicates the name of the standard object of the record.
id	The ID of the object.
fieldName	The name of the rich text area field.
contentReferenceId	The reference ID that uniquely identifies an image within a rich text area field. You can obtain the reference by retrieving information for the object. The description shows the contents of the rich text area field. For example: `1{ 2 "attributes" : { 3 "type" : "Lead", 4 "url" : "/services/data/v55.0/sobjects/Lead/00QRM000003ZfDb2AK" 5 }, 6 "Id" : "00QRM000003ZfDb2AK", 7 ... 8 "ContactPhoto__c" : 9 "Sarah Loehr and her two dogs. 10 <img alt=\"Sarah Loehr.\" 11 src=\"https://MyDomainName.file.force.com/servlet/rtaImage? 12 eid=00QRM000003ZfDb& 13 feoid=00NRM000001E73j& 14 refid=0EMRM00000002Ip\"></img>" 15}` The refid parameter of the image (`0EMRM00000002Ip` in this example) is the contentReferenceId. If you’re not using enhanced domains, your org’s My Domain URLs are different. For details, see My Domain URL Formats in Salesforce Help. Note

Example

For an example of retrieving the blob data from a rich text area field, see Get an Image from a Rich Text Area Field.

Error responses

See Status Codes and Error Responses.

REST API Developer Guide

sObject Rich Text Image Retrieve

See Also