User Interface API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
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
User Interface API Request Bodies
User Interface API Response Bodies
User Interface API Appendices
PDF

Get an App

Get the metadata for an app.
Resource
/ui-api/apps/${appId}
Available Version
43.0
HTTP Method
GET
Example

As an example, let’s say that the user has an app with an ID of 06mRM000000AFIrYAO. To get metadata for this app, make this request:

GET /services/data/v64.0/ui-api/apps/06mRM000000AFIrYAO?formFactor=Large

The request returns metadata for the app and its 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
App