---
schema_version: "1"
id: d6676ebc8788b59918c00b4e95ce470888c3f495f26cf5e04bbe4afa69abf394
title: CustomTab
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_customtab.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_customtab.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6f47fc098cfca4506cbfed7a74a9d200407d93492cfa683581523488b2324fe8
description: Represents a custom tab.
---
# CustomTab

Represents a custom tab.

This object is available in the Tooling API version 33.0 and later.

## Supported Calls

create(), delete(), query(), retrieve(), update()

## Fields

| Field | Details |
| --- | --- |
| ContentId | 
Type

reference

Properties

Filter, Group, Nillable, Sort

Description

Read-only. The ID of the item that the custom tab points to. For Lightning components, this is the ID of the component bundle. For custom object tabs, this field is null.



 |
| Description | 

Type

string

Properties

Filter, Nillable, Sort

Description

The tab’s description.



 |
| DeveloperName | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

The developer’s internal name for the custom tab.



 |
| EncodingKey | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

Read-only. Type of encoding assigned to the URL called by the tab. The default encoding setting is Unicode: UTF-8. Change it if you are passing information to a URL that requires data in a different format. This option is available when the value URL is selected in the tab type. Valid values are:

- UTF-8—Unicode (UTF-8)
- ISO-8859-1—General US & Western Europe (ISO-8859–1, ISO-LATIN-1)
- Shift\_JIS—Japanese (Shift-JIS)
- ISO-2022-JP—Japanese (JIS)
- EUC-JP—Japanese (EUC-JP)
- x-SJIS\_0213—Japanese (Shift-JIS\_2004)
- ks\_c\_5601-1987—Korean (ks\_c\_5601-1987)
- Big5—Traditional Chinese (Big5)
- GB2312—Simplified Chinese (GB2312)
- Big5-HKSCS—Traditional Chinese Hong Kong (Big5–HKSCS)





 |
| FullName | 

Type

string

Properties

Create, Group, Nillable

Description

The name of the tab. The value of this field depends on the type of tab, and the API version.

- For custom object tabs, the fullName is the developer-assigned name of the custom object (MyCustomObject\_\_c, for example).
- For Web tabs, the fullName is the developer-assigned name of the tab (MyWebTab, for example).

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.



 |
| HasSidebar | 

Type

boolean

Properties

Defaulted on create, Filter, Group, Sort

Description

Indicates if the tab displays the sidebar panel.



 |
| ManageableState | 

Type

ManageableState enumerated list

Properties

Filter, Group, Nillable, Restricted picklist, Sort

Description

Indicates the manageable state of the specified component that is contained in a package:

- beta
- deleted
- deprecated
- deprecatedEditable
- installed
- installedEditable
- released
- unmanaged





 |
| MasterLabel | 

Type

string

Properties

Filter, Group, idLookup, Nillable, Sort

Description

Required. The label for the custom tab, which displays in Setup.



 |
| Metadata | 

Type

CustomTabMetadata

Properties

Create, Nillable, Update

Description

Custom tab metadata.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.



 |
| MotifName | 

Type

string

Properties

Filter, Group, Sort

Description

Read-only. The name of the tab style assigned to the custom tab.



 |
| NamespacePrefix | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

The namespace of the package of which the custom tab is a part.



 |
| Type | 

Type

picklist

Properties

Filter, Group, Restricted picklist, Sort

Description

The type of custom tab. Valid values are:

- apexPage
- aura
- customObject
- flexiPage
- sControl
- url





 |
| Url | 

Type

string

Properties

Filter, Nillable, Sort

Description

The URL for the external web-page to embed in this tab.



 |