Get Apps

Get metadata for all the apps a user has access to. App metadata for the currently selected app includes its navigation items, but navigation items are not populated for other apps.

Resource

1/ui-api/apps

Available version

43.0

HTTP methods

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/v43.0/ui-api/apps?formFactor=Large

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

1{
2  "apps" : [ {
3    "appId" : "06mRM000000AFIrYAO",
4    "description" : "Manage customer service with accounts, contacts, cases, and more",
5    "developerName" : "Service",
6    "formFactors" : [ "Large" ],
7    "headerColor" : "#0070D2",
8    "iconUrl" : "https://yourInstance.salesforce.com/logos/Salesforce/ServiceCloud/icon.png",
9    "isNavAutoTempTabsDisabled" : false,
10    "isNavPersonalizationDisabled" : false,
11    "label" : "Service",
12    "logoUrl" : "https://yourInstance.salesforce.com/logos/Salesforce/ServiceCloud/logo.png",
13    "mobileStartUrl" : null,
14    "navItems" : [ {
15      "availableInClassic" : true,
16      "availableInLightning" : true,
17      "color" : "EF7EAD",
18      "content" : "home__desktopDefault",
19      "custom" : false,
20      "developerName" : "standard-home",
21      "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/standard/home_120.png",
22      "id" : null,
23      "itemType" : "Standard",
24      "label" : "Home",
25      "objectApiName" : "Home",
26      "pageReference" : {
27        "attributes" : {
28          "pageName" : "home"
29        },
30        "state" : { },
31        "type" : "standard__namedPage"
32      },
33      "standardType" : "Home"
34    }, {
35      "availableInClassic" : false,
36      "availableInLightning" : true,
37      "color" : "489DD0",
38      "content" : null,
39      "custom" : false,
40      "developerName" : "standard-Feed",
41      "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/standard/feed_120.png",
42      "id" : null,
43      "itemType" : "Standard",
44      "label" : "Chatter",
45      "objectApiName" : "Feed",
46      "pageReference" : {
47        "attributes" : {
48          "pageName" : "chatter"
49        },
50        "state" : { },
51        "type" : "standard__namedPage"
52      },
53      "standardType" : "Feed" 
54    } ],
55    "selected" : true,
56    "startUrl" : "https://yourInstance.salesforce.com/home/home.jsp?tsid=02uRM000000AFIr",
57    "uiType" : "Classic",
58    "userNavItems" : [ ]
59  }, 
60
61... Additional actions removed for brevity ...
62    {
63    "appId" : "06mRM000000AFIqYAO",
64    "description" : "Best-in-class on-demand marketing automation",
65    "developerName" : "Marketing",
66    "formFactors" : [ "Large" ],
67    "headerColor" : "#0070D2",
68    "iconUrl" : "https://yourInstance.salesforce.com/logos/Salesforce/MarketingCloud/icon.png",
69    "isNavAutoTempTabsDisabled" : false,
70    "isNavPersonalizationDisabled" : false,
71    "label" : "Marketing",
72    "logoUrl" : "https://yourInstance.salesforce.com/logos/Salesforce/MarketingCloud/logo.png",
73    "mobileStartUrl" : null,
74    "navItems" : [ ],
75    "selected" : false,
76    "startUrl" : "https://yourInstance.salesforce.com/home/home.jsp?tsid=02uRM000000AFIq",
77    "uiType" : "Classic",
78    "userNavItems" : [ ]
79  }, {
80    "appId" : "06mRM0000005NZWYA2",
81    "description" : "Discover and manage business solutions designed for your industry.",
82    "developerName" : "LightningBolt",
83    "formFactors" : [ "Large" ],
84    "headerColor" : "#0070D2",
85    "iconUrl" : "https://yourInstance.salesforce.com/logos/Salesforce/LightningBolt/icon.png",
86    "isNavAutoTempTabsDisabled" : false,
87    "isNavPersonalizationDisabled" : false,
88    "label" : "Bolt Solutions",
89    "logoUrl" : "https://yourInstance.salesforce.com/logos/Salesforce/LightningBolt/logo.png",
90    "mobileStartUrl" : null,
91    "navItems" : [ ],
92    "selected" : false,
93    "startUrl" : "https://yourInstance.salesforce.com/home/home.jsp?tsid=02uRM0000005NZW",
94    "uiType" : "Lightning",
95    "userNavItems" : [ ]
96  } ]
97}

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`formFactor`	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.	Required	43.0
`userCustomizations`	Boolean	If `true`, returns the list of app items including user-customized and admin-defined.	Optional	43.0

Response body for GET

Apps

User Interface API Developer Guide

Get Apps