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` `installed` `released` `unmanaged` For more information about states of manageability for components in Force.com AppExchange packages, see “Planning the Release of Managed Packages” in the Salesforce online help.
Metadata	Type CustomFieldMetadata Properties Create, Nillable, Update Description CustomFieldMetadata includes the following fields: `caseSensitive` `customDataType^` `defaultValue` `deleteConstraint` `deprecated^` `description` `displayFormat` `displayLocationInDecimal` `escapeMarkup` `externalDeveloperName` `externalId` `formula` `formulaTreatBlanksAs` `inlineHelpText` `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.
TableEnumOrId	Type Restricted picklist Properties Filter, Group, Sort Description The enum (for example, Account) or ID of the object this field is on.

Force.com Tooling API

CustomField

Supported SOAP Calls

Supported REST HTTP Methods

Fields