ODBC Driver for Zoho CRM

Build 26.0.9770

ListFields

Returns field metadata for all fields in a specified module.

Table-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.
  • Id supports the '=' operator.

For example, the following queries are processed server-side: 

SELECT * FROM ListFields WHERE ModuleName = 'Deals'
SELECT * FROM ListFields WHERE ModuleName = 'Deals' AND Id = '1234567890123456789'

Insert

To insert a record into ListFields, you must at least supply values for the ModuleName, DataType, and FieldLabel columns. 
INSERT INTO ListFields (ModuleName, DataType, FieldLabel) VALUES ('Leads','text', 'Test');

Update

Specify the Id and ModuleName in the WHERE clause when executing an update in this table. 

UPDATE ListFields SET FieldLabel = 'UPT' WHERE Id = '1234567890123456789' AND ModuleName = 'Leads';

Delete

Specify the Id and ModuleName in the WHERE clause when executing a delete in this table. 

DELETE FROM ListFields WHERE Id = '1234567890123456789' AND ModuleName = 'Leads';

Columns

Name Type ReadOnly Description
ApiName String True

The API name of the field.

AssociationDetails String True

The details of any associations connected to the field.

BlueprintSupported Boolean True

Indicates whether the field supports Blueprint.

BusinesscardSupported Boolean True

Indicates whether the field supports business card display.

ConvertMappingAccounts String True

The field mapping for the Accounts module when converting a lead.

ConvertMappingContacts String True

The field mapping for the Contacts module when converting a lead.

ConvertMappingDeals String True

The field mapping for the Deals module when converting a lead.

CreatedSource String True

The source through which the field was created.

Crypt String False

The encryption configuration details for the field.

CurrencyPrecision Integer True

The number of decimal places used for currency values in the field.

CurrencyRoundingOption String True

The rounding option applied to currency values in the field.

CustomField Boolean True

Indicates whether the field is a custom field.

DataType String False

The data type of the field, such as text, integer, or date.

DecimalPlace Integer True

The number of decimal places configured for the field.

DisplayField Boolean True

Indicates whether the field is a display field.

DisplayLabel String True

The label displayed for the field in the user interface.

DisplayType Integer True

The numeric code representing the display type of the field.

External String True

The external source details for the field, if the field is mapped to an external system.

FieldLabel String False

The label of the field as defined by the user.

FieldReadOnly Boolean True

Indicates whether the field is read-only.

Filterable Boolean False

Indicates whether the field is filterable.

HistoryTracking String True

The history tracking configuration for the field.

Id [KEY] String True

The unique Id of the field.

JsonType String True

The JSON data type of the field.

Length Integer False

The maximum character length allowed for the field.

MassUpdate Boolean True

Indicates whether mass update is supported for this field.

PickListValues String True

The list of available values for the pick list field.

PickListValuesSortedLexically Boolean True

Indicates whether pick list values are sorted lexically.

Profiles String False

The profiles that have access to the field.

QuickSequenceNumber String True

The sequence number of the field in the Quick Create layout.

ReadOnly Boolean True

Indicates whether the field is read-only.

Sortable Boolean True

Indicates whether the field is sortable.

SystemMandatory Boolean True

Indicates whether the field is system-mandatory.

Tooltip String False

The tooltip text displayed when a user hovers over the field.

Type String True

The category type of the field.

UiType Integer True

The numeric code representing the user interface type of the field.

ViewTypeCreate Boolean True

Indicates whether the field is displayed in the Create view.

ViewTypeEdit Boolean True

Indicates whether the field is displayed in the Edit view.

ViewTypeQuickCreate Boolean True

Indicates whether the field is displayed in the Quick Create view.

ViewTypeView Boolean True

Indicates whether the field is displayed in the detail view.

Visible Boolean True

Indicates whether the field is visible.

Webhook Boolean True

Indicates whether the field is webhook-enabled.

Searchable Boolean True

Indicates whether the field is searchable.

SharingProperties String True

The access permissions for the records referenced by the lookup field.

AssociatedModuleName String True

The name of the module associated with the parent modules' fields.

AssociatedModuleId String True

The Id of the module associated with the parent modules' fields.

OperationTypeWebUpdate Boolean True

Indicates whether the field can be updated through the web.

OperationTypeAPICreate Boolean True

Indicates whether the field can be created through the API.

OperationTypeWebCreate Boolean True

Indicates whether the field can be created through the web.

OperationTypeAPIUpdate Boolean True

Indicates whether the field can be updated through the API.

PrivateRestricted Boolean False

Indicates whether the field's data has restricted access when accessed via the API.

PrivateExport Boolean False

Indicates whether the field's data has restricted access when exported.

PrivateType String False

The restriction level of the field based on its configuration in the layout.

VirtualField Boolean True

Indicates whether the field is a virtual field. Virtual fields are reference-only fields that contain metadata but do not hold actual values, and are used for subforms, multi-select lookups, multi-user lookups, and system-generated fields like Full_Name.

TextAreaType String True

The type of the multiline text area field.

AllowedPermissionsToUpdateReadOnly Boolean True

Indicates whether the field's default permission is read-only, meaning the user can only view the field.

AllowedPermissionsToUpdateReadWrite Boolean True

Indicates whether the field's default permission is read-write, meaning the user can edit the field.

AllowedPermissionsToUpdateHidden Boolean True

Indicates whether the field's default permission is hidden, meaning the field is not visible to the user.

LookupId String True

The Id of the lookup that the field is related to.

LookupDisplayLabel String True

The display label of the lookup that the field is related to.

LookupRevalidateFilterDuringEdit Boolean True

Indicates whether the lookup filter is revalidated when a record is edited.

LookupAPIName String True

The API name of the lookup that the field is related to.

LookupModuleAPIName String True

The API name of the module for the lookup that the field is related to.

LookupModuleCrypt Boolean True

Indicates whether the module of the related lookup is encrypted.

LookupModuleId String True

The Id of the module for the lookup that the field is related to.

LookupQueryDetails String True

The query details of the lookup that the field is related to.

HistoryTrackingEnabled Boolean True

Indicates whether history tracking is enabled for the pick list field.

Wizard Long True

The identifier of the wizard associated with the field, if applicable.

MultiSelectLookupLinkingDetailsModuleVisibility Integer True

The visibility setting for the linking module in the multi-select lookup.

MultiSelectLookupLinkingDetailsModulePluralLabel String True

The plural display label of the linking module as shown in the user interface.

MultiSelectLookupLinkingDetailsModuleAPIName String True

The API name of the linking module.

MultiSelectLookupLinkingDetailsModuleId String True

The unique Id of the linking module.

MultiSelectLookupLinkingDetailsLookupFieldAPIName String True

The API name of the current module's lookup field in the linking module.

MultiSelectLookupLinkingDetailsLookupFieldFieldLabel String True

The display name of the current module's lookup field in the linking module as shown in the user interface.

MultiSelectLookupLinkingDetailsLookupFieldId String True

The unique Id of the current module's lookup field in the linking module.

MultiSelectLookupLinkingDetailsConnectedLookupFieldAPIName String True

The API name of the connected module's lookup field in the linking module.

MultiSelectLookupLinkingDetailsConnectedLookupFieldFieldLabel String True

The display label of the connected module's lookup field in the linking module.

MultiSelectLookupLinkingDetailsConnectedLookupFieldId String True

The unique Id of the connected module's lookup field in the linking module.

MultiSelectLookupConnectedDetailsFieldAPIName String True

The API name of the current module's lookup field in the connected module.

MultiSelectLookupConnectedDetailsFieldFieldLabel String True

The display name of the current module's lookup field in the connected module.

MultiSelectLookupConnectedDetailsFieldId String True

The unique Id of the current module's lookup field in the connected module.

MultiSelectLookupConnectedDetailsModulePluralLabel String True

The plural label of the connected module.

MultiSelectLookupConnectedDetailsModuleAPIName String True

The API name of the connected module.

MultiSelectLookupConnectedDetailsModuleId String True

The unique Id of the connected module.

MultiSelectLookupConnectedDetailsLayouts String True

The details of the layout in which the current module's lookup field is associated with the connected module.

MultiSelectLookupRelatedListDisplayLabel String True

The display label of the lookup field in the current module.

MultiSelectLookupRelatedListAPIName String True

The API name of the lookup field in the current module.

MultiSelectLookupRelatedListId String True

The unique Id of the lookup field in the current module.

MultiUserLookupLinkingDetailsModulePluralLabel String True

The plural display label of the linking module as shown in the user interface.

MultiUserLookupLinkingDetailsModuleAPIName String True

The API name of the linking module.

MultiUserLookupLinkingDetailsModuleId String True

The unique Id of the linking module.

MultiUserLookupLinkingDetailsLookupFieldAPIName String True

The API name of the current module's lookup field in the linking module.

MultiUserLookupLinkingDetailsLookupFieldFieldLabel String True

The display name of the current module's lookup field in the linking module as shown in the user interface.

MultiUserLookupLinkingDetailsLookupFieldId String True

The unique Id of the current module's lookup field in the linking module.

MultiUserLookupLinkingDetailsConnectedLookupFieldAPIName String True

The API name of the connected module's lookup field in the linking module.

MultiUserLookupLinkingDetailsConnectedLookupFieldFieldLabel String True

The display label of the connected module's lookup field in the linking module.

MultiUserLookupLinkingDetailsConnectedLookupFieldId String True

The unique Id of the connected module's lookup field in the linking module.

Subform String True

The details of the line items in the inventory modules.

Formula String True

The formula details for the field, if the field is a formula field.

EnableColourCode Boolean True

Indicates whether the field can be color-coded.

AutoNumber String True

The auto-number configuration details for the field. Auto-number fields automatically generate a unique number for each record based on a specified format, such as invoice numbers or order IDs.

RollupSummaryReturnType String True

The return type of the rollup summary field.

RollupSummaryExpressionFunctionParameters String True

The function parameters used in the rollup summary expression.

RollupSummaryExpressionCriteriaGroupOperator String True

The group operator used in the rollup summary criteria (for example, AND or OR).

RollupSummaryExpressionCriteriaGroup String True

The group of criteria for the rollup summary calculation.

RollupSummaryExpressionFunction String True

The function used for the rollup summary calculation (for example, AVERAGE).

RollupSummaryBasedOnModuleAPIName String True

The API name of the module on which the rollup summary is based.

RollupSummaryBasedOnModuleId String True

The Id of the module on which the rollup summary is based.

RollupSummaryRelatedListAPIName String True

The API name of the related list on which the rollup summary is based.

RollupSummaryRelatedListId String True

The Id of the related list on which the rollup summary is based.

RollupSummaryRollupBasedOn String True

The basis of the rollup summary calculation (for example, module or layout).

ModuleName [KEY] String False

The name of the module whose fields to retrieve.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770