ListFields
Provides metadata about fields used in list views of a given module, including field visibility and display order.
View-Specific Information
Select
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.
- ModuleName supports the '=' operator.
For example, the following queries are processed server-side:
SELECT * FROM ListFields WHERE ModuleName = 'Deals'
Columns
| Name | Type | Description |
| ApiName | String | API name of the field used in programmatic access. |
| AssociationDetails | String | Details about field associations with other modules or records. |
| BlueprintSupported | Boolean | Indicates whether the field is supported in blueprints. |
| BusinesscardSupported | Boolean | Indicates whether the field appears on the business card view. |
| ConvertMappingAccounts | String | Field mapping configuration used when converting leads to accounts. |
| ConvertMappingContacts | String | Field mapping configuration used when converting leads to contacts. |
| ConvertMappingDeals | String | Field mapping configuration used when converting leads to deals. |
| CreatedSource | String | Source from which the field was originally created. |
| Crypt | String | Encryption configuration or cryptographic settings associated with the field. |
| CurrencyPrecision | Integer | Number of decimal places used for currency precision. |
| CurrencyRoundingOption | String | Rounding option applied to currency values for the field. |
| CustomField | Boolean | Indicates whether the field is a custom field. |
| DataType | String | Data type of the field, such as string, integer, or boolean. |
| DecimalPlace | Integer | Number of decimal places allowed for the field value. |
| DisplayField | Boolean | Indicates whether the field is used as a display field in lookup modules. |
| DisplayLabel | String | Label of the field shown in the user interface. |
| DisplayType | Integer | Code indicating how the field is displayed in the UI. |
| External | String | External mapping or configuration associated with the field. |
| FieldLabel | String | Descriptive label assigned to the field. |
| FieldReadOnly | Boolean | Indicates whether the field is read-only. |
| Filterable | Boolean | Indicates whether the field can be used as a filter in views and reports. |
| HistoryTracking | String | Indicates whether field history tracking is enabled and its configuration. |
| Id | String | Unique identifier of the field. |
| JsonType | String | Data type of the field in JSON format. |
| Length | Integer | Maximum allowed length for the field value. |
| MassUpdate | Boolean | Indicates whether the field supports mass update operations. |
| PickListValues | String | Comma-separated list of allowed values if the field is a picklist. |
| PickListValuesSortedLexically | Boolean | Indicates whether picklist values are sorted alphabetically. |
| Profiles | String | Comma-separated list of profiles with access to this field. |
| QuickSequenceNumber | String | Quick sequence number used for ordering fields in UI. |
| ReadOnly | Boolean | Indicates whether the field is read-only across all profiles. |
| Sortable | Boolean | Indicates whether the field supports sorting in views. |
| Subform | String | Subform configuration if the field represents a subform section. |
| SystemMandatory | Boolean | Indicates whether the field is mandatory at the system level. |
| Tooltip | String | Tooltip text shown when hovering over the field in the UI. |
| Type | String | Type category of the field, such as lookup, text, or currency. |
| UiType | Integer | UI type code that defines how the field is rendered in the interface. |
| ViewTypeCreate | Boolean | Indicates whether the field is shown in the create view. |
| ViewTypeEdit | Boolean | Indicates whether the field is shown in the edit view. |
| ViewTypeQuickCreate | Boolean | Indicates whether the field is shown in the quick create view. |
| ViewTypeView | Boolean | Indicates whether the field is visible in the record detail view. |
| Visible | Boolean | Indicates whether the field is visible in the module. |
| Webhook | Boolean | Indicates whether changes to the field can trigger a webhook. |
| ModuleName | String | Name of the module to which this field belongs. |