User Interface API Developer Guide
jNewer Version Available
Get Started with User Interface API
User Interface API enables you to create native mobile apps and custom web apps with
your own branding and look and feel. A single REST request returns enough metadata, layout
information, and data to display, edit, or create a record.
| Available in: Developer Edition |
The User Interface API base URL is https://{your_instance}.salesforce.com/services/data/v{api_version}/ui-api.
Use the resources in the pilot version of User Interface API to display records.
- GET /ui-api/record-ui/{recordIds}
- GET /ui-api/layout/{objectApiName}
- GET /ui-api/object-info/{objectApiName}
- GET /ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}/{fieldApiName}
- GET /ui-api/records/{recordId}
- PATCH /ui-api/records/{recordId}
- DELETE /ui-api/records/{recordId}
- GET /ui-api/records/batch/{recordIds}
- POST /ui-api/records
- GET /ui-api/record-defaults/clone/{recordId}
- GET /ui-api/record-defaults/create/{apiName}
The first resource in the list, the Record UI resource, is the top dog of User Interface API. To
display a record, your code makes this simple
request:
1GET /ui-api/record-ui/001R0000003GeJ1IAKBehind 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.