User Interface API Developer Guide

Get Started with User Interface API
User Interface API Features
User Interface API Resources
Records
Actions
Favorites
Lists
Apps
Get Apps
Get an App
Update Last Selected App
Get Last Selected App
Get Personalized Navigation Items
Get All Navigation Items
Update Personalized Navigation Items
Get Active Theme
Session CSRF Token
User Interface API Request Bodies
User Interface API Response Bodies
User Interface API Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Get Apps

Get metadata for all the apps a user has access to. Metadata for the selected app includes tabs on the app’s navigation bar. Metadata for other apps doesn’t include tabs on the navigation bar.
Resource
1/ui-api/apps
Available Version
43.0
HTTP Method
GET
Example

As an example, let’s say that the user has access to three apps: Service, Marketing, and Bolt Solutions. To get metadata for all the apps, make this request:

1GET /services/data/v67.0/ui-api/apps?formFactor=Large

The request returns metadata for the apps and their associated navigation tabs.

Request Parameters
Parameter Name Type Description Required or Optional Available Version
formFactor String The form factor for each app that the user has access to.
  • Large—App supports the desktop display size.
  • Medium—App supports the tablet display size.
  • Small—App supports the phone display size.
 Required 43.0
userCustomizations Boolean If true, gets custom and standard navigation tabs. If false, gets only standard navigation tabs. Optional 43.0
Response Body
Apps