Get All Navigation Items

Gets all navigation items (tabs) that the user has access to.

Resource

1/ui-api/nav-items

Available version

45.0

HTTP methods

GET

Example

To get all navigation tabs for an app, make this request:

1GET /services/data/v46.0/ui-api/nav-items??page=3&pageSize=2

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

1{
2  "currentPageUrl": "/services/data/v46.0/ui-api/nav-items?page=3&pageSize=2"
3  "navItems": [{
4    "availableInClassic": true,
5    "availableInLightning": true,
6    "color": "EF7EAD",
7    "content": "home__desktopDefault",
8    "custom": false,
9    "developerName": "standard-home",
10    "iconUrl": "https://yourInstance.salesforce.com/img/icon/t4v35/standard/home_120.png",
11    "id": null,
12    "itemType": "Standard",
13    "label": "Home",
14    "objectApiName": "Home",
15    "pageReference": {
16      "attributes": {
17        "pageName": "home"
18      },
19      "state": {},
20      "type": "standard__namedPage"
21    },
22    "standardType": "Home"
23  }, {
24    "availableInClassic": false,
25    "availableInLightning": true,
26    "color": "489DD0",
27    "content": null,
28    "custom": false,
29    "developerName": "standard-Feed",
30    "iconUrl": "https://yourInstance.salesforce.com/img/icon/t4v35/standard/feed_120.png",
31    "id": null,
32    "itemType": "Standard",
33    "label": "Chatter",
34    "objectApiName": "Feed",
35    "pageReference": {
36      "attributes": {
37        "pageName": "chatter"
38      },
39      "state": {},
40      "type": "standard__namedPage"
41    },
42    "standardType": "Feed"
43  }],
44  "nextPageUrl": "/services/data/v46.0/ui-api/nav-items?page=4&pageSize=2"
45}

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`formFactor`	String	The form factor for each navigation tab that the user has access to. `Large`—Navigation tab supports the desktop display size. `Medium`—Navigation tab supports the tablet display size. `Small`—Navigation tab supports the phone display size.	Optional	45.0
`pageSize`	Int	The maximum number of child records to return on a page. The default value is 25.	Optional	45.0
`page`	Int	The page offset from which to begin returning records. The default value is 0, which returns records from the first page. For example, for `page=2` and `pageSize=10`, the first record returned is the 21st record in the list.	Optional	45.0

Response body for GET

Navigation Items

User Interface API Developer Guide

Get All Navigation Items