REST API Developer Guide

Introduction to REST API
Quick Start
Examples
Getting Information About My Organization
Working with Object Metadata
Working with Records
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

Newer Version Available

This content describes an older version of this product. View Latest

Get an Image from a Rich Text Area Field

Use the sObject Rich Text Image Get resource to retrieve an image from a rich text area field. In this example, we retrieve an image from a custom rich text field of a Lead record called LeadPhotoRichText__c. We assume that an image has already been uploaded to this field.

Obtain the Image Reference ID

Before you can retrieve the image with a request, you must first obtain the refid from the rich text field. Use the sObject Rows resource to retrieve the field information for the Lead record. 

1curl https://MyDomainName.my.salesforce.com/services/data/v62.0/sobjects/Lead/00Q112222233333 -H "Authorization: Bearer token"

Here’s an example of abridged output from the request.

1{
2    "attributes": {
3        "type": "Lead",
4        "url": "/services/data/v51.0/sobjects/Lead/00Q112222233333"
5    },
6    "Id": "00Q112222233333",
7    "IsDeleted": false,
8    "MasterRecordId": null,
9    "LastName": "Smith",
10    "FirstName": "John",
11
12    ...
13
14    "LeadPhotoRichText__c": "<img alt=\"johnSmithPhoto\" src=\"https://MyDomainName.documentforce.com/servlet/rtaImage?eid=a005e000007Dksm&amp;feoid=00N5e00000djU6Y&amp;refid=0EM5e000000B9LQ\"></img>"
15}

You can see from the LeadPhotoRichText__c field that the refid of the image is 0EM5e000000B9LQ. Use this value in the next step to retrieve the image.

Retrieve the Image

Use the Lead record ID, rich text field name, and image refid to retrieve the image. The response returns the image as encoded data with the same file type as it was uploaded with. Save the returned data as an image file with the appropriate file type using the --output filename parameter.

1curl https://MyDomainName.my.salesforce.com/services/data/v62.0/sobjects/Lead/00Q112222233333/richTextImageFields/LeadPhotoRichText__c/0EMR00000000A8V -H "Authorization: Bearer token" --output "LeadPhoto.jpeg"