User Interface API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with User Interface API
User Interface API Features
User Interface API Resources
User Interface API Request Bodies
User Interface API Response Bodies
User Interface API Appendices
Supported Objects
All Supported Objects
List View Supported Objects
Most Recently Used List View Supported Objects
Retired Resources
Retired Response Bodies
PDF

Supported Objects

User Interface API supports all custom objects and external objects and many standard objects.

To get a directory of objects that are supported by the API and accessible to the context user, use the /ui-api/object-info resource.

To understand how the API operates on supported objects, let’s look at some examples.

This resource gets object metadata. It operates on any supported object.
GET /ui-api/object-info/{objectApiName}
This example gets Account metadata.
GET /ui-api/object-info/Account
This resource gets record data and metadata. It operates on any supported object record. 
GET /ui-api/record-ui/{recordIds}
This example gets data and metadata to display an Opportunity record.
GET /ui-api/record-ui/006RM000002XCd1YAG

Most User Interface API resources support these objects. Related lists resources support every object supported by User Interface API. The list views and most recently used list views resources support smaller sets of objects. For a list of all supported objects, see All Supported Objects.