TabDefinition

Represents a tab, and returns all tabs available in the org.

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

Note

Version 

Introduced in API version 43.0.

Supported SOAP API Calls 

describeSObjects(), query(), search()

Supported REST API Methods 

Query

Fields 

DurableId 

• Type: string

• Required: No

• 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

• Required: No

• 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.

• Default value: false

IsAvailableInDesktop 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 45.0

• Description: Set to true if the tab is available in the desktop user interface.

• Default value: false

IsAvailableInLightning 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Set to true if the tab is available in the Lightning Experience user interface.

• Default value: false

IsAvailableInMobile 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 45.0

• Description: Set to true if the tab is available in the Salesforce mobile app.

• Default value: false

IsCustom 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Set to true if the tab is a custom tab.

• Default value: false

Label 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The tab label in the Salesforce org.

MobileUrl 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 45.0

• 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

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The name of the tab.

SobjectName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Used with REST to retrieve the metadata for the tab.

Url 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The URL for where the tab directs the user.