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.

TabDefinition

Represents a tab, and returns all tabs available in the org. Available in API version 43.0 and later.

In API version 45.0 and later, only users with the “ViewSetup and Configuration” permission can access TabDefinition.

Note

Supported SOAP Calls

query(), search()

Supported REST HTTP Methods

Query, GET

Fields

Field Name	Details
DurableId	Type string Properties Filter, Group, Nillable, Sort Description Unique identifier for the field. Always retrieve this value before using it, as the value isn’t guaranteed to stay the same from one release to the next. To simplify queries, use this field.
IsAvailableInAloha	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Set to `true` if the tab is available in the Salesforce Classic user interface. If a tab is available in Salesforce Classic, then IsAvailableInMobile is `false`.
IsAvailableInDesktop	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Set to `true` if the tab is available in the desktop user interface.
IsAvailableInMobile	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Set to `true` if the tab is available in the Salesforce mobile app.
IsAvailableInLightning	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Set to `true` if the tab is available in the Lightning Experience user interface.
IsCustom	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Set to `true` if the tab is a custom tab.
Label	Type string Properties Filter, Group, Nillable, Sort Description The tab label in the Salesforce org.
MobileUrl	Type string Properties Filter, Group, Nillable, Sort Description If the tab is available in mobile, this is the URL that the tab directs the user to in the Salesforce mobile app. If the tab isn’t available in mobile, this is set to null.
Name	Type string Properties Filter, Group, Nillable, Sort Description The name of the tab.
SobjectName	Type string Properties Filter, Group, Nillable, Sort Description Used with REST to retrieve the metadata for the tab.
Url	Type string Properties Filter, Group, Nillable, Sort Description The URL for where the tab directs the user.

Tooling API

TabDefinition

Supported SOAP Calls

Supported REST HTTP Methods

Fields