Get All Navigation Items
GET {{_endpoint}}/services/data/v{{version}}/ui-api/nav-items
Gets all navigation items (tabs) that the user has access to.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
formFactor | string | The form factor for each app that the user has access to (Large, Medium or Small) | |
navItemNames | null | A comma delimited list of TabDefinition name values to include in the response. | |
page | null | The page offset form which to begin returning nav items. The default value is 0, which returns nav items from the first page. For example, for page=2 and pageSize=10, the first nav item returned is the 21st nav item in the list. | |
pageSize | null | The maximum number of nav items to return on a page. The default value is 25. |
RESPONSES
status: OK
{"currentPageUrl":"/services/data/v58.0/ui-api/nav-items?formFactor=Small\u0026page=1\u0026pageSize=5","eTag":"425dfe9232c5bd0e9c6e4b94771c91b8","navItems":[{"availableInClassic":true,"availableInLightning":true,"color":null,"content":"https://pozil-dev-ed.my.salesforce.com/4nK/o","custom":false,"developerName":"standard-AssetStatePeriod","iconUrl":null,"id":null,"itemType":"Entity","label":"Asset State Periods","objectApiName":"AssetStatePeriod","objectLabel":"Asset State Period","objectLabelPlural":"Asset State Periods","pageReference":{"attributes":{"objectApiName":"AssetStatePeriod","actionName":"home"},"state":{},"type":"standard__objectPage"},"standardType":null},{"availableInClassic":true,"availableInLightning":true,"color":null,"content":"https://pozil-dev-ed.my.salesforce.com/02i/o","custom":false,"developerName":"standard-Asset","iconUrl":null,"id":null,"itemType":"Entity","label":"Assets","objectApiName":"Asset","objectLabel":"Asset","objectLabelPlural":"Assets","pageReference":{"attributes":{"objectApiName":"Asset","actionName":"home"},"state":{},"type":"standard__objectPage"},"standardType":null},{"availableInClassic":true,"availableInLightning":true,"color":null,"content":"https://pozil-dev-ed.my.salesforce.com/0cI/o","custom":false,"developerName":"standard-AuthorizationForm","iconUrl":null,"id":null,"itemType":"Entity","label":"Authorization Form","objectApiName":"AuthorizationForm","objectLabel":"Authorization Form","objectLabelPlural":"Authorization Forms","pageReference":{"attributes":{"objectApiName":"AuthorizationForm","actionName":"home"},"state":{},"type":"standard__objectPage"},"standardType":null},{"availableInClassic":true,"availableInLightning":true,"color":null,"content":"https://pozil-dev-ed.my.salesforce.com/0cK/o","custom":false,"developerName":"standard-AuthorizationFormConsent","iconUrl":null,"id":null,"itemType":"Entity","label":"Authorization Form Consent","objectApiName":"AuthorizationFormConsent","objectLabel":"Authorization Form Consent","objectLabelPlural":"Authorization Form Consents","pageReference":{"attributes":{"objectApiName":"AuthorizationFormConsent","actionName":"home"},"state":{},"type":"standard__objectPage"},"standardType":null},{"availableInClassic":true,"availableInLightning":true,"color":null,"content":"https://pozil-dev-ed.my.salesforce.com/0cM/o","custom":false,"developerName":"standard-AuthorizationFormDataUse","iconUrl":null,"id":null,"itemType":"Entity","label":"Authorization Form Data Use","objectApiName":"AuthorizationFormDataUse","objectLabel":"Authorization Form Data Use","objectLabelPlural":"Authorization Form Data Uses","pageReference":{"attributes":{"objectApiName":"AuthorizationFormDataUse","actionName":"home"},"state":{},"type":"standard__objectPage"},"standardType":null}],"nextPageUrl":"/services/data/v58.0/ui-api/nav-items?formFactor=Small\u0026page=2\u0026pageSize=5"}