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 Personalized Navigation Items

Get a user’s personalized navigation items (tabs).

Resource

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

Available Version

43.0

HTTP Method

GET

Example

To get a user’s personalized navigation tabs for an app, make this request using the app ID:

1GET /services/data/v67.0/ui-api/apps/06mRM000000AFIrYAO/user-nav-items

The request returns metadata for the personalized navigation tabs associated with this app.

1{
2  "navItems" : [   {
3    "availableInClassic" : true,
4    "availableInLightning" : true,
5    "color" : "50E3C2",
6    "content" : "https://yourInstance.salesforce.com/0WO/o",
7    "custom" : false,
8    "developerName" : "standard-WorkOrder",
9    "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/standard/work_order_120.png",
10    "id" : "0QkR00000004CvtKAE",
11    "itemType" : "Entity",
12    "label" : "Work Orders",
13    "objectApiName" : "WorkOrder",
14    "pageReference" : {
15      "attributes" : {
16        "objectApiName" : "WorkOrder",
17        "actionName" : "home"
18      },
19      "state" : { },
20      "type" : "standard__objectPage"
21    },
22    "standardType" : null
23  }, {
24    "availableInClassic" : true,
25    "availableInLightning" : true,
26    "color" : "83B6FF",
27    "content" : "https://yourInstance.salesforce.com/_ui/core/chatter/groups/GroupListPage",
28    "custom" : false,
29    "developerName" : "standard-CollaborationGroup",
30    "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/standard/groups_120.png",
31    "id" : "0QkR000000002R3KAI",
32    "itemType" : "Standard",
33    "label" : "Groups",
34    "objectApiName" : "CollaborationGroup",
35    "pageReference" : {
36      "attributes" : {
37        "objectApiName" : "CollaborationGroup",
38        "actionName" : "home"
39      },
40      "state" : { },
41      "type" : "standard__objectPage"
42    },
43    "standardType" : "Groups"
44  }, {
45    "availableInClassic" : true,
46    "availableInLightning" : true,
47    "color" : "2ECBBE",
48    "content" : "https://yourInstance.salesforce.com/00O/o",
49    "custom" : false,
50    "developerName" : "standard-report",
51    "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/standard/report_120.png",
52    "id" : "0QkR000000007UxKAI",
53    "itemType" : "Standard",
54    "label" : "Reports",
55    "objectApiName" : "Report",
56    "pageReference" : {
57      "attributes" : {
58        "objectApiName" : "Report",
59        "actionName" : "home"
60      },
61      "state" : { },
62      "type" : "standard__objectPage"
63    },
64    "standardType" : "Reports"
65  } ]
66}

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.	Optional	43.0

Response Body

Navigation Items

User Interface API Developer Guide

Get Personalized Navigation Items