Zoho CRM connector reference

Important

This feature is in Beta. To use it, a workspace admin must turn on Lakeflow Connect for Zoho CRM from the Previews page. See Manage Azure Databricks previews.

This page has reference information for the managed Zoho CRM connector, including supported source tables and destination table schemas.

Supported source tables

The Zoho CRM connector supports the following source tables, all under the default source schema:

Source table	Primary key	Description	Sync mode	Cursor field
`leads`	`id`	Lead records.	Incremental	`Modified_Time`
`contacts`	`id`	Contact records.	Incremental	`Modified_Time`
`accounts`	`id`	Account records.	Incremental	`Modified_Time`
`deals`	`id`	Deal records.	Incremental	`Modified_Time`
`campaigns`	`id`	Campaign records.	Incremental	`Modified_Time`
`tasks`	`id`	Task activity records.	Incremental	`Modified_Time`
`calls`	`id`	Call activity records.	Incremental	`Modified_Time`
`events`	`id`	Meeting and event activity records.	Incremental	`Modified_Time`
`notes`	`id`	Notes attached to records.	Incremental	`Modified_Time`
`vendors`	`id`	Vendor records.	Incremental	`Modified_Time`
`quotes`	`id`	Quote records.	Incremental	`Modified_Time`
`sales_orders`	`id`	Sales order records.	Incremental	`Modified_Time`
`purchase_orders`	`id`	Purchase order records.	Incremental	`Modified_Time`
`solutions`	`id`	Solution records.	Incremental	`Modified_Time`
`cases`	`id`	Case records.	Incremental	`Modified_Time`
`invoices`	`id`	Invoice records.	Incremental	`Modified_Time`
`products`	`id`	Product records.	Incremental	`Modified_Time`
`deal_history`	`id`	Stage history entries for deals.	Incremental	`Modified_Time`
Custom module tables	`id`	One table per custom module that Zoho CRM reports as API-supported and viewable. Each table name is the module's API name in lowercase.	Incremental	`Modified_Time`
`price_books`	`id`	Price book records.	Incremental	`Modified_Time`
`invoiced_items`	`id`	Line items on invoices.	Incremental	`Modified_Time`
`quoted_items`	`id`	Line items on quotes.	Incremental	`Modified_Time`
`ordered_items_sales_order`	`id`	Line items on sales orders.	Incremental	`Modified_Time`
`purchase_items`	`id`	Line items on purchase orders.	Incremental	`Modified_Time`
`roles`	`id`	Roles in the organization's role hierarchy.	Full refresh only
`profiles`	`id`	User profiles.	Full refresh only
`currencies`	`id`	Currencies configured for the organization.	Full refresh only
`organization`	`id`	Organization details.	Full refresh only
`contact_roles`	`id`	Contact roles available for deals.	Full refresh only
`territories`	`id`	Territories configured in Territory Management.	Full refresh only
`users`	`id`	Users in the organization.	Incremental	`Modified_Time`
`stages`	`layout_id`, `pipeline_id`, `id`	Deal stages for each pipeline and layout.	Full refresh only
`tags`	`id`	Tags defined for each module.	Incremental	`modified_time`
`attachments`	`id`	Attachment metadata for records.	Incremental	`Modified_Time`
`user_territories`	`user_id`, `id`	Territories assigned to each user.	Full refresh only

Connector options

For usage, see Examples.

Option	Type	Scope	Required	Applies to	Description
`start_datetime`	String	Pipeline	Yes	All incremental tables	Earliest date and time from which to ingest data, in `yyyy-MM-ddTHH:mm:ssXXX` format (for example, `2024-01-01T00:00:00+00:00`). Applies only to the first sync of each table; later syncs resume from the stored cursor.

Automatic data transformations

For module tables, item tables, and custom module tables, Databricks transforms Zoho CRM field types to Delta-compatible data types as follows. Each field type shows the Zoho CRM UI name where one applies, followed by its data_type value in the Zoho CRM fields metadata API.

Zoho CRM field type	Delta type
Single Line (`text`)	String
Multi Line (`textarea`)	String
Email (`email`)	String
Phone (`phone`)	String
Website (`website`)	String
Pick List (`picklist`)	String
`multiselectpicklist`	Array of strings (`ARRAY<STRING>`)
Auto Number (`autonumber`)	String
Profile Image (`profileimage`)	String
`integer`	BigInt
Long Integer (`bigint`)	BigInt, or String when the API returns the value as a string
Decimal (`double`)	Double
`percent`	Double
Currency (`currency`)	Decimal(19, 4)
`decimal`	Decimal(19, 4)
`boolean`	Boolean
`date`	Date
`datetime`	Timestamp
Formula (`formula`)	Based on the formula's return type: Double (`double`), Decimal(38, 9) (`currency`), String (`text`), Date (`date`), Timestamp (`datetime`), or Boolean (`boolean`)
Rollup Summary (`rollup_summary`)	Based on the return type: Double (`double`), Decimal(38, 9) (`currency`), or BigInt (`integer`)
Lookup (`lookup`)	Variant
Owner (`ownerlookup`)	Variant
User (`userlookup`)	Variant
`multi_module_lookup`	Variant
Multi-Select Lookup (`multiselectlookup`)	Variant
Multi-User Lookup (`multiuserlookup`)	Variant
Subform (`subform`)	Variant
File Upload (`fileupload`)	Variant
Image Upload (`imageupload`)	Variant
Address (`address`)	Variant
`ALARM`, `multireminder`	Variant
`RRULE`	Variant
`linetax`	Variant
`Tag` field (`text` with a JSON array value)	Variant

Destination table schemas

Module tables and custom module tables

The connector builds the schema of each module table, item table, and custom module table from that module's field metadata in Zoho CRM. Each field becomes a column named with the field's API name, and the column's data type follows Automatic data transformations. Columns therefore include custom fields and vary by Zoho CRM organization. Every table also has an id column of type STRING.

These tables are leads, contacts, accounts, deals, campaigns, tasks, calls, events, notes, vendors, quotes, sales_orders, purchase_orders, solutions, cases, invoices, products, deal_history, price_books, invoiced_items, quoted_items, ordered_items_sales_order, purchase_items, and attachments.

The connector creates one custom module table for each custom module that Zoho CRM reports as API-supported and viewable to the connection user. The table name is the module's API name in lowercase. For example, a custom module with the API name Projects lands in the projects table.

Primary key: id Cursor field: Modified_Time

Note

Tables with VARIANT columns don't support slowly changing dimension (SCD) type 2. Most module tables have lookup fields, such as the record owner, that map to VARIANT.

`roles`

Primary key: id Sync mode: Full refresh only

Field	Data type
`id`	`STRING`
`name`	`STRING`
`display_label`	`STRING`
`api_name`	`STRING`
`description`	`STRING`
`share_with_peers`	`BOOLEAN`
`reporting_to`	`STRUCT<id: STRING, name: STRING>`
`forecast_manager`	`STRUCT<id: STRING, name: STRING>`
`created_by__s`	`STRUCT<name: STRING, id: STRING>`
`modified_by__s`	`STRUCT<name: STRING, id: STRING>`
`created_time__s`	`TIMESTAMP`
`modified_time__s`	`TIMESTAMP`

`profiles`

Primary key: id Sync mode: Full refresh only

Field	Data type
`id`	`STRING`
`name`	`STRING`
`display_label`	`STRING`
`api_name`	`STRING`
`description`	`STRING`
`type`	`STRING`
`custom`	`BOOLEAN`
`created_by`	`STRUCT<name: STRING, id: STRING>`
`modified_by`	`STRUCT<name: STRING, id: STRING>`
`created_time`	`TIMESTAMP`
`modified_time`	`TIMESTAMP`

`currencies`

Primary key: id Sync mode: Full refresh only Availability: Requires Multi-Currency, which is available in Professional edition or above.

Field	Data type
`id`	`STRING`
`name`	`STRING`
`iso_code`	`STRING`
`symbol`	`STRING`
`prefix_symbol`	`BOOLEAN`
`is_base`	`BOOLEAN`
`is_active`	`BOOLEAN`
`exchange_rate`	`STRING`
`exchange_rate_auto_update`	`BOOLEAN`
`exchange_rate_updated_time`	`TIMESTAMP`
`format`	`STRUCT<numeral_system: STRING, decimal_places: STRING, decimal_separator: STRING, thousand_separator: STRING>`
`created_by`	`STRUCT<name: STRING, id: STRING>`
`modified_by`	`STRUCT<name: STRING, id: STRING>`
`created_time`	`TIMESTAMP`
`modified_time`	`TIMESTAMP`

`organization`

Primary key: id Sync mode: Full refresh only

Field	Data type
`id`	`STRING`
`company_name`	`STRING`
`domain_name`	`STRING`
`alias`	`STRING`
`primary_email`	`STRING`
`phone`	`STRING`
`mobile`	`STRING`
`fax`	`STRING`
`website`	`STRING`
`street`	`STRING`
`city`	`STRING`
`state`	`STRING`
`country`	`STRING`
`country_code`	`STRING`
`zip`	`STRING`
`description`	`STRING`
`type`	`STRING`
`currency`	`STRING`
`currency_symbol`	`STRING`
`currency_locale`	`STRING`
`iso_code`	`STRING`
`time_zone`	`STRING`
`employee_count`	`STRING`
`created_time`	`TIMESTAMP`
`mc_status`	`BOOLEAN`
`gapps_enabled`	`BOOLEAN`
`translation_enabled`	`BOOLEAN`
`photo_id`	`STRING`
`primary_zuid`	`STRING`
`zia_portal_id`	`INT`
`zgid`	`STRING`
`deletable_org_account`	`BOOLEAN`
`license_details`	`STRUCT<paid_expiry: TIMESTAMP, users_license_purchased: INT, trial_type: STRING, trial_expiry: TIMESTAMP, paid: BOOLEAN, paid_type: STRING, portal_users_license_purchased: INT>`
`hierarchy_preferences`	`STRUCT<type: STRING, strictly_reporting: BOOLEAN>`
`privacy_settings`	`BOOLEAN`
`hipaa_compliance_enabled`	`BOOLEAN`
`lite_users_enabled`	`BOOLEAN`

`contact_roles`

Primary key: id Sync mode: Full refresh only

Field	Data type
`id`	`STRING`
`name`	`STRING`
`sequence_number`	`BIGINT`

`territories`

Primary key: id Sync mode: Full refresh only Availability: Requires Territory Management, which is available in Enterprise edition or above.

Field	Data type
`id`	`STRING`
`name`	`STRING`
`api_name`	`STRING`
`description`	`STRING`
`manager`	`STRUCT<name: STRING, id: STRING, zuid: STRING, status: STRING>`
`reporting_to`	`STRUCT<name: STRING, id: STRING>`
`permission_type`	`STRING`
`created_time`	`TIMESTAMP`
`modified_time`	`TIMESTAMP`
`created_by`	`STRUCT<name: STRING, id: STRING>`
`modified_by`	`STRUCT<name: STRING, id: STRING>`
`account_rule_criteria`	`VARIANT`
`lead_rule_criteria`	`VARIANT`
`deal_rule_criteria`	`VARIANT`

Note

This table does not support SCD type 2 because it has VARIANT columns.

`users`

Primary key: id Cursor field: Modified_Time

Field	Data type
`id`	`STRING`
`first_name`	`STRING`
`last_name`	`STRING`
`full_name`	`STRING`
`email`	`STRING`
`phone`	`STRING`
`mobile`	`STRING`
`fax`	`STRING`
`role`	`STRUCT<name: STRING, id: STRING>`
`profile`	`STRUCT<name: STRING, id: STRING>`
`status`	`STRING`
`type__s`	`STRING`
`confirm`	`BOOLEAN`
`locale`	`STRING`
`language`	`STRING`
`time_zone`	`STRING`
`offset`	`INT`
`date_format`	`STRING`
`time_format`	`STRING`
`Currency`	`STRING`
`dob`	`DATE`
`country`	`STRING`
`city`	`STRING`
`state`	`STRING`
`street`	`STRING`
`zip`	`STRING`
`country_locale`	`STRING`
`alias`	`STRING`
`website`	`STRING`
`signature`	`STRING`
`zuid`	`STRING`
`image_link`	`STRING`
`share_among_subordinates`	`BOOLEAN`
`created_time`	`TIMESTAMP`
`Modified_Time`	`TIMESTAMP`
`created_by`	`STRUCT<name: STRING, id: STRING>`
`Modified_By`	`STRUCT<name: STRING, id: STRING>`
`Reporting_To`	`STRUCT<name: STRING, id: STRING>`
`customize_info`	`VARIANT`
`microsoft`	`BOOLEAN`
`personal_account`	`BOOLEAN`
`Isonline`	`BOOLEAN`
`sandboxDeveloper`	`BOOLEAN`
`sort_order_preference__s`	`STRING`
`name_format__s`	`STRING`
`status_reason__s`	`STRING`
`theme`	`STRUCT<normal_tab: STRUCT<background: STRING, font_color: STRING>, selected_tab: STRUCT<background: STRING, font_color: STRING>, header: STRUCT<background: STRING, font_color: STRING>, new_background: STRING, background: STRING, screen: STRING, type: STRING>`
`$current_shift`	`STRUCT<name: STRING, id: STRING>`
`$next_shift`	`STRUCT<name: STRING, id: STRING>`
`$shift_effective_from`	`DATE`
`Confirmed_Time__s`	`TIMESTAMP`
`Invited_By__s`	`STRUCT<name: STRING, id: STRING>`
`Invited_Time__s`	`TIMESTAMP`
`Preferred_Currency__s`	`VARIANT`
`Status_Updated_By__s`	`STRUCT<name: STRING, id: STRING>`
`Status_Updated_Time__s`	`TIMESTAMP`
`decimal_separator`	`STRING`
`default_tab_group`	`STRING`
`distance_preference__s`	`STRING`
`number_separator`	`STRING`

Note

This table does not support SCD type 2 because it has VARIANT columns.

`stages`

Primary key: layout_id, pipeline_id, id Sync mode: Full refresh only

Field	Data type
`id`	`STRING`
`display_value`	`STRING`
`actual_value`	`STRING`
`sequence_number`	`BIGINT`
`colour_code`	`STRING`
`forecast_category`	`STRUCT<name: STRING, id: STRING>`
`forecast_type`	`STRING`
`pipeline_id`	`STRING`
`pipeline_name`	`STRING`
`layout_id`	`STRING`

`tags`

Primary key: id Cursor field: modified_time

Field	Data type
`id`	`STRING`
`name`	`STRING`
`color_code`	`STRING`
`module`	`STRING`
`created_by`	`STRUCT<name: STRING, id: STRING>`
`modified_by`	`STRUCT<name: STRING, id: STRING>`
`created_time`	`TIMESTAMP`
`modified_time`	`TIMESTAMP`

`user_territories`

Primary key: user_id, id Sync mode: Full refresh only Availability: Requires Territory Management, which is available in Enterprise edition or above.

Field	Data type
`user_id`	`STRING`
`id`	`STRING`
`Name`	`STRING`
`Manager`	`STRUCT<name: STRING, id: STRING>`
`Reporting_To`	`STRUCT<name: STRING, id: STRING>`

Required OAuth permissions

The connector requests the following read-only OAuth scopes for the Zoho Self Client. For more information, see Zoho CRM OAuth scopes.

Permission	Required for
`ZohoCRM.modules.READ`	Module tables, item tables, custom module tables, `contact_roles`
`ZohoCRM.modules.attachments.READ`	`attachments`
`ZohoCRM.coql.READ`	Module tables, item tables, custom module tables
`ZohoCRM.settings.modules.READ`	Custom module discovery, `tags`
`ZohoCRM.settings.fields.READ`	Schema discovery for module tables, item tables, and custom module tables
`ZohoCRM.settings.currencies.READ`	`currencies`
`ZohoCRM.settings.territories.READ`	`territories`, `user_territories`
`ZohoCRM.settings.tags.READ`	`tags`
`ZohoCRM.settings.pipeline.READ`	`stages`
`ZohoCRM.settings.layouts.READ`	`stages`
`ZohoCRM.settings.roles.READ`	`roles`
`ZohoCRM.settings.profiles.READ`	`profiles`
`ZohoCRM.users.READ`	`users`, `user_territories`
`ZohoCRM.org.READ`	`organization`

Feedback

Was this page helpful?

Last updated on 2026-10-26

Zoho CRM connector reference

Supported source tables

Connector options

Automatic data transformations

Destination table schemas

Module tables and custom module tables

roles

profiles

currencies

organization

contact_roles

territories

users

stages

tags

user_territories

Required OAuth permissions

Feedback

Additional resources

`roles`

`profiles`

`currencies`

`organization`

`contact_roles`

`territories`

`users`

`stages`

`tags`

`user_territories`