User Interface API

Build Salesforce UI for native mobile apps and custom web apps.

New and Changed User Interface API Resources

These resources are new or have changes.

Session CSRF

Get the Cross-Site Request Forgery (CSRF) token for your session to protect requests from malicious third-party sites forgeries
Make a GET request to the new /ui-api/session/csrf resource.
New response body: CSRF Token

Changed User Interface API Response Bodies

These response bodies have changes.

Actions

Platform Action
This response body has these new properties.
  • pageDeveloperName—For flexipage-backed quick actions, the developer name of the FlexiPage, resolved server-side from QuickActionDefinition.ComponentId.
  • targetParentField—The lookup field on the target object that points to the target parent record.
  • targetRecordTypeId—For flexipage-backed quick actions, the target record type ID from the QuickActionDefinition.

Lists

List Object Info
This response body has these new and changed properties.
  • publicCreateable—Indicates whether the context user can create a public list view for the object.
  • publicOrSharedCreateable—This property is deprecated. In version 67.0 and later, we recommend using publicCreateable or sharedCreateable.
  • sharedCreateable—Indicates whether the context user can create a shared list view for the object.

Themes

Theme
This response body has this new property that is reserved for future use.
  • brandImageDarkMode

Supported Objects

All new standard objects are auto-enabled for use with User Interface API.

To view new objects that are auto-enabled for User Interface API, see New and Changed Objects.

These standard objects aren’t new to your org but are new for User Interface API.

  • Attachment
  • AuthProvider
  • BatchJobDefinition
  • BatchJobPart
  • CartItemPriceAdjustment
  • Event
    Note
    Note User Interface API added support for the event object late in API version 66.0.
  • Task
    Note
    Note User Interface API added support for the task object late in API version 66.0.
  • UserUiPreference
  • WorkforceCapacity
  • WorkforceCapacityPlan

These standard objects are already supported in User Interface API, and they’re newly supported for list views and most recently used list views.

  • ActionPlan
  • BatchJob
  • BatchJobPartFailedRecord
  • ContentNote
  • CreditMemo
  • Crisis
  • EmployeeCrisisAssessment
  • Payment

These standard objects are already supported in User Interface API and for list views, and they’re newly supported for most recently used list views.

  • SvcCatalogItemDef