ListFields
Get the field metadata for the specified module.
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 | The API Name. |
| AssociationDetails | String | The Association Details. |
| BlueprintSupported | Boolean | Is Blueprint Supported. |
| BusinesscardSupported | Boolean | Is Businesscard Supported. |
| ConvertMappingAccounts | String | The Convert Mapping Accounts. |
| ConvertMappingContacts | String | The Convert Mapping Contacts. |
| ConvertMappingDeals | String | The Convert Mapping Deals. |
| CreatedSource | String | The Created Source. |
| Crypt | String | The Crypt. |
| CurrencyPrecision | Integer | The Currency Precision. |
| CurrencyRoundingOption | String | The Currency Rounding Option. |
| CustomField | Boolean | Is Custom Field. |
| DataType | String | The Data Type. |
| DecimalPlace | Integer | The Decimal Place. |
| DisplayField | Boolean | Is Display Field. |
| DisplayLabel | String | The Display Label. |
| DisplayType | Integer | The Display Type. |
| External | String | The External. |
| FieldLabel | String | The Field Label. |
| FieldReadOnly | Boolean | Is Field ReadOnly. |
| Filterable | Boolean | Is Filterable. |
| HistoryTracking | String | The History Tracking. |
| Id | String | The Id. |
| JsonType | String | The JSON Type. |
| Length | Integer | The Length. |
| MassUpdate | Boolean | Is Mass Update. |
| PickListValues | String | The Pick List Values. |
| PickListValuesSortedLexically | Boolean | Are Pick List Values Sorted Lexically. |
| Profiles | String | The Profiles. |
| QuickSequenceNumber | String | The QuickSequenceNumber. |
| ReadOnly | Boolean | Is ReadOnly. |
| Sortable | Boolean | Is Sortable. |
| SystemMandatory | Boolean | Is System Mandatory. |
| Tooltip | String | The Tool tip. |
| Type | String | The Type. |
| UiType | Integer | The Ui Type. |
| ViewTypeCreate | Boolean | Is View Type Create. |
| ViewTypeEdit | Boolean | Is View Type Edit. |
| ViewTypeQuickCreate | Boolean | Is View Type Quick Create. |
| ViewTypeView | Boolean | Is View Type View. |
| Visible | Boolean | Is Visible. |
| Webhook | Boolean | Is Webhook. |
| Searchable | Boolean | Represents whether the field is supported in a search. |
| SharingProperties | String | In a lookup field, represents if the user has access to the records that the field looks up to. |
| AssociatedModuleName | String | Represents the module name of the fields associated with the parent modules. |
| AssociatedModuleId | String | Represents the module ID of the fields associated with the parent modules. |
| OperationTypeWebUpdate | Boolean | Represents whether the field can be updated through web. |
| OperationTypeAPICreate | Boolean | Represents whether the field can be created through api. |
| OperationTypeWebCreate | Boolean | Represents whether the field can be created through web. |
| OperationTypeAPIUpdate | Boolean | Represents whether the field can be updated through api. |
| PrivateRestricted | Boolean | Represents if normal or sensitive data has restricted access when accessed via API. |
| PrivateExport | Boolean | Represents if normal or sensitive data has restricted access when exported. |
| PrivateType | String | Specifies the restriction level based on field configuration in the layout. |
| VirtualField | Boolean | Virtual fields are reference-only fields that contain metadata but do not hold actual values. It is used for subforms, multi-select lookups, multi-user lookups, and system-generated fields like Full_Name. |
| TextAreaType | String | Contains the type of the multiline field. |
| AllowedPermissionsToUpdateReadOnly | Boolean | Represents the default permissions for the field, 'true' means the user can only view the field. |
| AllowedPermissionsToUpdateReadWrite | Boolean | Represents the default permissions for the field, 'true' means the user can edit the field. |
| AllowedPermissionsToUpdateHidden | Boolean | Represents the default permissions for the field, 'true' means the field is hidden from the user. |
| LookupId | String | Represents the ID of the lookup that the field is related to. |
| LookupDisplayLabel | String | Represents the display label of the lookup that the field is related to. |
| LookupRevalidateFilterDuringEdit | Boolean | Represents whether to revalidate filter during edits of the lookup that the field is related to. |
| LookupAPIName | String | Represents the api name of the lookup that the field is related to. |
| LookupModuleAPIName | String | Represents the module api name of the lookup that the field is related to. |
| LookupModuleCrypt | Boolean | Represents the module crypt of the lookup that the field is related to. |
| LookupModuleId | String | Represents the module ID of the lookup that the field is related to. |
| LookupQueryDetails | String | Represents the query details of the lookup that the field is related to. |
| HistoryTrackingEnabled | Boolean | Represents whether history tracking feature is enabled for the picklist field. |
| Wizard | Long | Represents that the field is a wizard. |
| MultiSelectLookupLinkingDetailsModuleVisibility | Integer | Represents the linking module visibility. |
| MultiSelectLookupLinkingDetailsModulePluralLabel | String | Represents the display label of the linking module visible in the UI. |
| MultiSelectLookupLinkingDetailsModuleAPIName | String | Represents the API name of the linking module. |
| MultiSelectLookupLinkingDetailsModuleId | String | Represents the unique ID of the linking module. |
| MultiSelectLookupLinkingDetailsLookupFieldAPIName | String | Represents the API name of the current module's lookup field in the linking module. |
| MultiSelectLookupLinkingDetailsLookupFieldFieldLabel | String | Represents the display name of the current module's lookup field in the linking module visible in the UI. |
| MultiSelectLookupLinkingDetailsLookupFieldId | String | Represents the current module lookup field's unique ID in the linking module. |
| MultiSelectLookupLinkingDetailsConnectedLookupFieldAPIName | String | Represents the API name of the connected module's lookup field in the linking module. |
| MultiSelectLookupLinkingDetailsConnectedLookupFieldFieldLabel | String | Represents the display label of the connected module's lookup field in the linking module. |
| MultiSelectLookupLinkingDetailsConnectedLookupFieldId | String | Represents the unique ID of the connected module's lookup field in the linking module. |
| MultiSelectLookupConnectedDetailsFieldAPIName | String | Represents the API name of the current module's lookup field in the connected module. |
| MultiSelectLookupConnectedDetailsFieldFieldLabel | String | Represents the display name of the current module's lookup field in the connected module. |
| MultiSelectLookupConnectedDetailsFieldId | String | Represents the unique ID of the current module's lookup field in the connected module. |
| MultiSelectLookupConnectedDetailsModulePluralLabel | String | Represents the plural label of the connected module. |
| MultiSelectLookupConnectedDetailsModuleAPIName | String | Represents the API name of the connected module. |
| MultiSelectLookupConnectedDetailsModuleId | String | Represents the unique ID of the connected module. |
| MultiSelectLookupConnectedDetailsLayouts | String | Contains details of the layout in which the current module's lookup field is associated with the connected module. |
| MultiSelectLookupRelatedListDisplayLabel | String | Represents the display label of the lookup field in the current module. |
| MultiSelectLookupRelatedListAPIName | String | Represents the API name of the lookup field in the current module. |
| MultiSelectLookupRelatedListId | String | Represents the unique ID of the lookup field in the current module. |
| MultiUserLookupLinkingDetailsModulePluralLabel | String | Represents the display label of the linking module visible in the UI. |
| MultiUserLookupLinkingDetailsModuleAPIName | String | Represents the API name of the linking module. |
| MultiUserLookupLinkingDetailsModuleId | String | Represents the unique ID of the linking module. |
| MultiUserLookupLinkingDetailsLookupFieldAPIName | String | Represents the API name of the current module's lookup field in the linking module. |
| MultiUserLookupLinkingDetailsLookupFieldFieldLabel | String | Represents the display name of the current module's lookup field in the linking module visible in the UI. |
| MultiUserLookupLinkingDetailsLookupFieldId | String | Represents the current module lookup field's unique ID in the linking module. |
| MultiUserLookupLinkingDetailsConnectedLookupFieldAPIName | String | Represents the API name of the connected module's lookup field in the linking module. |
| MultiUserLookupLinkingDetailsConnectedLookupFieldFieldLabel | String | Represents the display label of the connected module's lookup field in the linking module. |
| MultiUserLookupLinkingDetailsConnectedLookupFieldId | String | Represents the unique ID of the connected module's lookup field in the linking module. |
| Subform | String | Represents the details of the line items in the inventory modules. |
| Formula | String | Represents the formula details, if the current field is a formula field. |
| EnableColourCode | Boolean | Represents if the field can be color-coded. |
| AutoNumber | String | Auto-number fields automatically generate a unique number for each record based on a specified format. This is useful for creating unique identifiers for records, such as invoice numbers or order IDs. |
| RollupSummaryReturnType | String | Specifies the type of the rollup summary field. |
| RollupSummaryExpressionFunctionParameters | String | Specifies the function parameters used in the expression. |
| RollupSummaryExpressionCriteriaGroupOperator | String | Specifies the group operator used in the criteria (e.g., AND, OR). |
| RollupSummaryExpressionCriteriaGroup | String | Represents the group of criteria for the rollup summary calculation. |
| RollupSummaryExpressionFunction | String | Specifies the function used for the rollup summary calculation (e.g., AVERAGE). |
| RollupSummaryBasedOnModuleAPIName | String | Specifies the API name for the module on which the rollup summary is based. |
| RollupSummaryBasedOnModuleId | String | Specifies the ID of the module on which the rollup summary is based. |
| RollupSummaryRelatedListAPIName | String | Specifies the API name for the related list on which the rollup summary is based. |
| RollupSummaryRelatedListId | String | Specifies the ID of the related list on which the rollup summary is based. |
| RollupSummaryRollupBasedOn | String | Specifies the basis of the rollup summary calculation. It could be module or layout. |
| ModuleName | String | The name of the module which the user wants the fields. |