User Interface API Developer Guide

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 Top-Level Response Bodies
Action
App
Apps
Batch Results
Favorite
Favorite Collection
List Metadata
List Record Collection
List UI
List View Summary Collection
Lookup Values
Most Recently Used List Metadata
Most Recently Used List Record Collection
Most Recently Used List UI
Navigation Items
Object Info
Object Info Directory
Picklist Values
Picklist Values Collection
Record
Record Collection
Record Defaults
Record Layout
Record UI
Theme
User Interface API Nested Response Bodies
PDF

Newer Version Available

This content describes an older version of this product. View Latest

App

The metadata for a single app.
Property Name Type Description Filter Group and Version Available Version
appId String The unique ID of the app definition. Small, 43.0 43.0
description String A description for the app. Small, 43.0 43.0
developerName String The API name of the app. Small, 43.0 43.0
formFactors String The form factors for which the app is supported. One of these values:
  • Large—Use this value to get apps that support the desktop display size.
  • Medium—Use this value to get apps that support the tablet display size.
  • Small—Use this value to get apps that support the phone display size.
 Medium, 43.0 43.0
headerColor String Primary color for the app as selected by the admin. For example, #0070D2. Small, 43.0 43.0
iconUrl String Icon URL of the app. Small, 43.0 43.0
isNavAutoTempTabsDisabled Boolean Indicates whether the navigation automatically creates temporary tabs settings. Small, 43.0 43.0
isNavPersonalizationDisabled Boolean Indicates whether navigation personalization is disabled. Small, 43.0 43.0
label String The label of the app. Small, 43.0 43.0
logoUrl String Logo URL of the app as selected by the admin. Medium, 43.0 43.0
mobileStartUrl String Mobile-specific launch URL for the app. Medium, 43.0 43.0
navItems Navigation Item[] Metadata for the navigation items (tabs) of the app. Big, 43.0 43.0
selected Boolean If true, this app is the default app for the user. Big, 43.0 43.0
startUrl String The launch URL of the app. Medium, 43.0 43.0
uiType String The UI type for the app. One of these values:
  • Salesforce Classic
  • Lightning Experience
 Small, 43.0 43.0
userNavItems Navigation Item[] User's navigation items for the app, if applicable and requested. Big, 43.0 43.0