Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

App

The metadata for a single app.

Property Name	Type	Description	Filter Group and Version	Available Version
`appId`	String	The unique ID of the app.	Small, 43.0	43.0
`description`	String	A description of the app.	Small, 43.0	43.0
`developerName`	String	The API name of the app.	Small, 43.0	43.0
`formFactors`	String[]	The form factor of the app. One or more of these values: `Large`—App supports the desktop display size. `Medium`—App supports the tablet display size. `Small`—App supports the phone display size.	Medium, 43.0	43.0
`headerColor`	String	The primary color for the app as selected by an admin. For example, `#0070D2`.	Small, 43.0	43.0
`iconUrl`	String	The URL for the app’s icon.	Small, 43.0	43.0
`isNavAutoTempTabsDisabled`	Boolean	If `true`, the navigation automatically creates temporary tabs settings.	Small, 43.0	43.0
`isNavPersonalizationDisabled`	Boolean	If `true`, navigation personalization is disabled.	Small, 43.0	43.0
`label`	String	The label of the app.	Small, 43.0	43.0
`logoUrl`	String	The logo URL of the app as selected by the admin.	Medium, 43.0	43.0
`mobileStartUrl`	String	The mobile launch URL for the app. This field is used with connected apps and Experience Builder sites. For sites only, this location is a fully qualified domain name. For other apps, it’s a relative URL.	Medium, 43.0	43.0
`navItems`	Navigation Item[]	The metadata for the navigation tabs of the app. Only `navItems` with supported `formFactors` values are returned. Note	Big, 43.0	43.0
`selected`	Boolean	If `true`, this app is the default app for the user.	Big, 43.0	43.0
`startUrl`	String	The launch URL of the app.	Medium, 43.0	43.0
`type`	String	The type of the app. One of these values: `Classic` `Community` `Connected` `Lightning`	Small, 47.0	47.0
`uiType`	String	The UI type for the app. One of these values: `Salesforce Classic` `Lightning Experience` This property was deprecated in API version 47.0. From 47.0 onward, use `appType` instead.	Small, 43.0 - 46.0	43.0 - 46.0
`userNavItems`	Navigation Item[]	The user's navigation tabs for the app.	Big, 43.0	43.0