User Interface API Developer Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Get Child Records
Build UI for Picklists
Upload Binary Files
Prevent Record Duplication with Idempotent Record Writes
Upload Files
Work with Actions
Manage Favorites
Work with List Views
Manage Apps
Newer Version Available
Work with Records
Use User Interface API to build UI that lets users create, read,
update, and delete Salesforce records. Let’s look at two of the trickier aspects of the API:
how to work with child relationships, and how to upload binary files to
records.
User Interface API resources operate on all custom objects and supported standard objects.
Note
-
Get Child Records
User Interface API has several resources that include child records in their responses. If a record has many child relationships, a response can be huge and have a negative effect on performance. To get only the records you need, request records for specific child relationships and set the page size of the results. -
Build UI for Picklists
User Interface API exposes properties and resources that make it easy for a client to build picklists and dependent picklists. -
Upload Binary Files
If a record has a Base64 field, you can upload binary data to the field when you create or update a record. -
Prevent Record Duplication with Idempotent Record Writes
Use idempotent record writes to avoid duplication of records and server operations, which can occur when an app or client encounters a network connection issue. -
Upload Files
Upload documents and images or update the file with a new version.