Magidoc

IntegrationFilterProperty
Object

A CRM contact property that can be used to build an integration sync filter, with its data type, selectable options, and the operators valid for it.

Fields

#

allowedOperators

[IntegrationFilterOperator !]!
Non-null

The operators that may be applied to this property, based on its data type.

dataType

String !
Non-null

Normalized data type for choosing operators/inputs: 'text', 'number', 'date', 'datetime', 'enumeration', 'bool', or 'phone'.

description

String

Optional description of the property, suitable for a tooltip.

externalOptions

Boolean !
Non-null

True when this is an enumeration whose allowed values are sourced externally (e.g. they reference CRM users/owners) and could NOT be resolved to a concrete set. When true, Options is empty and the UI should render a free-text/token input instead of a value dropdown.

fieldType

String

Raw CRM field type (e.g. 'text', 'textarea', 'select', 'booleancheckbox', 'date') for choosing the input control.

groupName

String

Optional grouping/section the property belongs to in the CRM, for UI sectioning.

label

String !
Non-null

Human-friendly label for display.

name

String !
Non-null

The CRM-internal property name — used as the filter's propertyName.

options

[IntegrationCustomFieldOption !]

Selectable options for enumeration properties (option value = Id, display label = Name).

readOnly

Boolean !
Non-null

True when the property is read-only in the CRM. Read-only properties can still be used as filter criteria.

Usages

#

References

#

  • Field integrationFilterProperties from Query