User Interface API Developer Guide

Get Started with User Interface API
User Interface API Features
Work with Records
Work with Actions
Manage Favorites
Work with List Views
Manage Apps
User Interface API Resources
User Interface API Request Bodies
User Interface API Response Bodies
PDF

Newer Version Available

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

Manage Apps

An app is a collection of items that work together to serve a particular function. Salesforce apps come in two flavors: Classic apps and Lightning apps. Classic apps are created and managed in Salesforce Classic. Lightning apps are created and managed in Lightning Experience. Admins customize both types of apps to match the way users work.

Classic apps are a collection of standard and custom tabs, including most standard objects, custom objects, Visualforce tabs, Lightning component tabs, Canvas apps via Visualforce tabs, and web tabs. In Salesforce Classic, users use tabs to access objects, like accounts and leads. Tabs also serve up other features, such as the Home page or Chatter.

Lightning apps are a collection of items that include everything from the Classic apps list, plus Lightning page tabs, and utilities like Lightning Dialer. In Lightning apps, admins customize the app’s logo and enhance branding by customizing the color of the navigation bar. Navigation in Lightning Experience is similar to navigation in Salesforce Classic, but with some improvements. In Lightning Experience, users can complete actions and access recent records and lists directly from the navigation bar. Users can also switch between apps that have custom colors and branding.

Users can also personalize which items appear in their navigation bar in Lightning Experience or tabs in Salesforce Classic. Although users can’t completely override the navigation created by admins, they can add and reorder items or tabs from their view. In addition, in Lightning Experience, users can add Favorite items directly to their navigation bar.

Using these App resources, you can get a list of apps, items from an app, and the presentation data for a user’s navigation.

To return metadata for a list of all apps for the current user, use this resource.

1GET /ui-api/apps

To return metadata about a specific app, use this resource.

1GET /ui-api/apps/${appId}

To return metadata about a specific app, and save the app as the last accessed app for the user, use this resource.

1PATCH /ui-api/apps/${appId}

To return metadata about the app the current user last selected, or sees by default, use this resource.

1GET /ui-api/apps/selected

To return metadata about a user’s personalized navigation, use this resource.

1GET /ui-api/apps/${appId}/user-nav-items

To return metadata for a list of all navigation tabs for the current user, use this resource.

1GET /ui-api/nav-items