Get Started with User Interface API

Build Salesforce UI for native mobile apps and custom web apps using the same API that Salesforce uses to build Salesforce for Android, iOS, and mobile web and Lightning Experience. Not only do you get data and metadata in a single response, but the response matches metadata changes made to the org by Salesforce admins. You don’t have to worry about layouts, picklists, field-level security, or sharing—all you have to do is build an app that users love.

Available in: Enterprise, Performance, Unlimited, and Developer Editions

The User Interface API base URL is https://{your_instance}.salesforce.com/services/data/v{api_version}/ui-api.

The Record UI resource shows the power of User Interface API. To display a record, your code makes this simple request:

1GET /ui-api/record-ui/001R0000003GeJ1IAK

Behind the scenes, Salesforce does the heavy lifting.

Checks field-level security settings, sharing settings, and perms.
Makes SOQL queries to get record data.
Gets object metadata and theme information.
Gets layout information.

You are one happy developer, because Salesforce transforms the results into an easy-to-consume JSON response with all the metadata and data necessary to display the record.

In addition to building UI for Salesforce records, you can also use User Interface API to build UI for Salesforce actions and favorites.

User Interface API Developer Guide

Get Started with User Interface API