---
schema_version: "1"
id: bbf2982b409be71e864559ffe77730535eacb292230f7771c6fd29f283e7bed0
title: CustomField
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_customfield.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_customfield.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: ef6252e4f00e6c81dc694b30f4daeb870fa2b4597ecc84c6d14dc1f30ec22dd9
description: Represents a custom field on a custom object that stores data unique to your organization. Includes access to the associated CustomField object and related fields in Salesforce Metadata API. Available from API version 28.0 or later.
---
# CustomField

Represents a custom field on a custom object that stores data unique to your organization. Includes access to the associated CustomField object and related fields in Salesforce Metadata API. Available from API version 28.0 or later.

## Supported SOAP Calls

create(), query(), retrieve(), search(), update(), upsert()

## Supported REST HTTP Methods

Query, GET, POST, PATCH

## Fields

| Field Name | Details |
| --- | --- |
| DeveloperName | 
Type

string

Properties

Filter, Group, Sort

Description

The developer’s internal name for the custom field. For example, the internal name for the custom field CF\_\_c is CF.



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





 |
| Metadata | 

Type

CustomFieldMetadata

Properties

Create, Nillable, Update

Description

CustomFieldMetadata includes these fields. For more information, see [CustomField](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/customfield.htm "HTML (New Window)") in the Metadata API Developer Guide.

- caseSensitive
- complianceGroup
- defaultValue
- deleteConstraint
- deprecated\*
- description
- displayFormat
- displayLocationInDecimal
- elementType\*
- escapeMarkup
- externalDeveloperName
- externalId
- formula
- formulaTreatBlanksAs
- inlineHelpText
- isAIPredictionField
- isFilteringDisabled
- isNameField
- isSortingDisabled
- label
- length
- maskChar
- maskType
- picklist
- populateExistingRows
- precision
- readOnlyProxy
- referenceTo
- relationshipLabel
- relationshipName
- relationshipOrder
- reparentableMasterDetai
- required
- restrictedAdminField
- scale
- startingNumber
- stripMarkup
- summarizedField
- summaryFilterItems
- summaryForeignKey
- summaryOperation
- trackFeedHistory
- trackHistory
- type
- unique
- visibleLines
- writeRequiresMasterRead

\* Reserved for future use.

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.



 |
| NamespacePrefix | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

The namespace of the custom field. A custom field can be in an extension namespace different than the object.



 |
| creationType | 

Type

DefinitionCreationType (enumeration of type string)

Properties

Filter, Group, Nillable, Sort

Description

Describes whether this field was added by the user or as part of a standard taxonomy.

Available in API version 67.0 and later:

- Ad\_Audience\_Insights
- Auxiliary
- Clean\_Room
- Deletion\_Records
- Problem\_Records





 |
| TableEnumOrId | 

Type

Restricted picklist

Properties

Filter, Group, Sort

Description

The enum (for example, Account) or ID of the object this field is on.



 |