Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ConnectApi.FieldMetadata

Search metadata for the field of an object.
Property Name Type Description Available Version
domain String The object that the field is associated with. 63.0
field String Field path through the object. 63.0
fieldApiName String API name of the field. 63.0
fieldType ConnectApi.​FieldType Field type. Values are:
  • Address
  • AnyType
  • Base64
  • Boolean
  • Combobox
  • ComplexValue
  • Currency
  • DataCategoryGroupReference
  • Date
  • DateTime
  • Double
  • Email
  • EncryptedString
  • ExtensionEntityLookup
  • ExternalLookup
  • FloatArray
  • Id
  • ImageUrl
  • IndirectLookup
  • Integer
  • Json
  • Location
  • Long
  • MultiPicklist
  • Percent
  • PersonName
  • Phone
  • Picklist
  • PlainTextArea
  • Reference
  • RichTextArea
  • Sobject
  • String
  • SwitchablePersonName
  • TextArea
  • Time
  • Url
63.0
filterable Boolean Specifies whether the field is filterable (true) or not (false). 63.0
highlightable Boolean Specifies whether the field is highlightable (true) or not (false). 63.0
label String Label of the field. 63.0
sortable Boolean Specifies whether the field is sortable (true) or not (false). 63.0