Field

A field's metadata.

Property Name	Type	Description	Filter Group and Version	Available Version
`apiName`	String	The API name for this field.	Small, 39.0	39.0
`calculated`	Boolean	Indicates whether the field is a custom formula field.	Small, 39.0	39.0
`compound`	Boolean	Indicates whether the field is a top-level compound field. If the `dataType` is `Location`, this value is usually `false`.	Small, 39.0	39.0
`controllerName`	String	The name of the field that controls the values of this picklist.	Small, 39.0	39.0
`createable`	Boolean	Indicates whether the field can be created.	Small, 39.0	39.0
`custom`	Boolean	Indicates whether the field is custom.	Small, 39.0	39.0
`dataType`	String	Field type. One of these values: `Address` `Base64` `Boolean` `ComplexValue`—Complex Value Type (CVT). `Currency` `Date` `DateTime` `Double` `Email` `EncryptedString` `Int` `Location` `MultiPicklist` `Percent` `Phone` `Picklist` `Reference` `String` `TextArea` `Time` `Url`	Small, 39.0	39.0
`extraTypeInfo`	String	More data type information. One of these values: `ExternalLookup`—External lookup `ImageUrl`—Image url `IndirectLookup`—Indirect lookup `PersonName`—Person name `PlainTextArea`—Plain text area `RichTextArea`—Rich text area `SwitchablePersonName`—Switchable person name	Small, 39.0	39.0
`filterable`	Boolean	Indicates whether the field is filterable. If true, then this field can be specified in the WHERE clause of a SOQL statement.	Small, 39.0	39.0
`filteredLookupInfo`	Filtered Lookup Info	If the field is a reference field type with a lookup filter, this value contains the lookup information.	Small, 39.0	39.0
`highScaleNumber`	Boolean	Indicates whether the field stores numbers to 8 decimal places regardless of what's specified in the field details.	Small, 39.0	39.0
`htmlFormatted`	Boolean	Indicates whether the field has been formatted for HTML and should be encoded for display in HTML. Also indicates whether a field is a custom formula field that has an IMAGE text function.	Small, 39.0	39.0
`label`	String	Text label that is displayed next to the field in the Salesforce user interface. This label may be localized.	Small, 39.0	39.0
`length`	Integer	For string fields, the maximum size of the field in number of Unicode characters (not bytes).	Small, 39.0	39.0
`nameField`	Boolean	Indicates whether the field is a name field.	Small, 39.0	39.0
`picklistValuesUrls`	Map<String, URL>	A mapping of record type IDs to Picklist Values resources. Make a request to the URL to get picklist values for the field in the context of a record type.	Small, 39.0	39.0
`precision`	Integer	For double fields, indicates the maximum number of digits that can be stored, on both sides of the decimal point.	Small, 39.0	39.0
`reference`	Boolean	Indicates whether the field is a foreign key reference to another record.	Small, 39.0	39.0
`referenceTargetField`	String	For indirect lookup relationships on external objects, the target custom field of the referenced object.	Medium, 39.0	39.0
`referenceToInfos`	Reference To Info[]	For fields that refer to other objects, this list includes information about the object types and name fields of the referenced objects.	Small, 39.0	39.0
`relationshipName`	String	The name of the relationship, if this relationship is a master-detail relationship field.	Small, 39.0	39.0
`required`	Boolean	Indicates whether the field is required on create or update.	Small, 39.0	39.0
`scale`	Integer	For double fields, indicates the number of digits to the right of the decimal point.	Small, 39.0	39.0
`sortable`	Boolean	Indicates whether a query can sort on this field.	Small, 39.0	39.0
`updateable`	Boolean	Indicates whether the field can be updated.	Small, 39.0	39.0

User Interface API Developer Guide

Field