User Interface API Developer Guide

Get Started with User Interface API
User Interface API Features
User Interface API Resources
Records
Get Record Data and Object Metadata
Get Record Layout Metadata
Get a Directory of Supported Objects
Get Object Metadata
Get a Batch of Object Metadata
Get Values for a Picklist Field
Get Values for All Picklist Fields of a Record Type
Get Child Records
Get a Record
Get a Batch of Records
Create or Clone a Record
Create a Batch of Records
Get Default Values to Clone a Record
Get Default Values to Clone a Record—Lightweight
Get Default Values to Create a Record
Get Default Values to Create a Record—Lightweight
Update a Record
Update a Batch of Records
Delete a Record
Delete a Batch of Records
Get Lookup Field Suggestions With POST
Check for Duplicate Records
Get Duplicate Management Configuration for a Specified Object
Upload a File
Upload a New File Version
Actions
Favorites
Lists
Apps
Get Active Theme
Session CSRF Token
User Interface API Request Bodies
User Interface API Response Bodies
User Interface API Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Get Values for All Picklist Fields of a Record Type

Use this resource to get the values for all the picklist fields of a specific record type. This resource is especially useful for getting dependent picklist values. For example, if an object has a tree of dependent picklists (Continents__c, Countries__c, Cities__c), use this resource to get all the values for each picklist in one request.

This resource is available as a static method in Apex in API version 66.0 and later. See getPicklistValuesByRecordType(objectApiName, recordTypeId) in the Apex Reference Guide.

Resource
1/ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}
  • objectApiName—The API name of a supported object.
  • recordTypeId—The ID of the record type.
Available Version
42.0
HTTP Method
GET
Response Body
Picklist Values Collection

Turn on source tracking in your sandboxes in order for the picklist values to appear correctly upon the UI API request. You can also use the Metadata API request with object and field inputs to fetch the picklist values of a record type.

Note