Zoho: Retrieve modules

← Modules operations · Get started

Operation zoho.getmodules

Provider route: GET /crm/v8/settings/modules. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["modules"]["getModules"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.modules.getModules(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.modules.get_modules(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.status	string	Optional	Maximum length: 56 Pattern: ^(visible|scheduled_for_deletion|user_hidden|system_hidden)(,(visible|scheduled_for_deletion|user_hidden|system_hidden))*$
query.feature_name	string	Optional	One of: Kiosk_Test_Run, sales_motivator_games_users, functions, linkingmodule_custom_field_long_integer, smart_prompt_zia_llm, voc_parent, linkingmodule_custom_field_dataparam, mb_delete_limit_popup, unsubscribe, query_sources, field_updates, crl_queries_click, web_case, google_instant_booking, emailsai_summary_translation, ASKZIA_MODULE_CREATION, static_subform_max_rows, triggers, public_field, custom_field_datetime, extensions, mass_email, nextgenui_new_panel_enabled, connected_workflows_limit, CANVAS_META_CACHE_REVERTER, send_mail_attachments_total_count, date_queries, production_tracking, nbx_early_access, picklist colour coding V2, custom_field_dataparam, teammodule_custom_field, address_field_enabled, data_storage_count, privacy_modules, email_relay, manage_signals, wizard_cross_screen_fields_in_criteria, page_layout, sample_subfeature_1, zoho_reports, hipaa_compliance, custom_dashboards, imap, Kiosk_Screens, abm, massconvert_dealcreation_newflow, best_mode_to_contact_special_access, action_field_update_product_configurator, send_mail_inventory_module, bounce_email_block, reports, personal_health_fields, Lead_Status_Mapping, CANVAS_META_CACHE, analytics, create_record, anomaly_notifications, organize_tabs, wf_di_notification, pathfinder_processing_count, Kiosk, detailview_customization, orchestration_execution_limit, export, picklist colour coding, detailview_canvasrules, duplicate_check_preference, bigin_domain_mapping, web_tabs, Kiosk_GetRecords_Fetch_limit, custom_field_decision_box, emailsai_test_account, notes_short_content, lookup_filter_new_mapping, email_notifications, exchange, portal_readonlymodule, custom_field_imageupload, bcc_dropbox, gsuite, writing_assistant, adwords, roles, voc, consent_email, disable_nio_flow, custom_button_api_name_page_lyte, linkingmodule_custom_field_radio, firstname_limit_increase_revert, autofollowup_rules, microsoft_office, support_access, records_limit_custom_view, zoho_mobile_edition, outlook, DATA_BRIDGE, association_per_global_field, subform_custom_field_check_box, WF_BH_FLOW_CHANGE, rfm_segmentation_contribution_module, bulk_write, file_storage_per_user, event_rsvp_update, slack, custom_related_list, cscript_dotsdk_spec_flow, QuickML_Integration, zia_config, linkingmodule_custom_field_date, mass_convert, price_rule_volume, smart_prompt_new_bot, zia_agent_in_cb, kiosk_versions_wise, record_level_sharing_groups, linkingmodule_custom_field_rich_text, printview_customization, LZ_FAAS_TEST, linkingmodule_custom_field_imageupload, related_list_customization, portals_signup_form, gdpr_lyte_revamp, zia_agent, email_storage_ui, email_templates_attachments_total_size, global_picklist_colourCode, zoho_projects, Stage_Probability_Mapping, email_parser, web_apps, email_intent_workflow, FX_CREDITS_STATIC_ISSUE_FIX, Stage_Used_Option_Count, user_licenses, data_storage, REPORT_FORMULA_DYNAMIC_GROUP_LIMIT, Kiosk_Components, zoho_campaigns, canvas_reusable_component, comparator, custom_field_date, custom_field_text_area, web_vendor, abm_segment_export, Kiosk_GetRecord_Selection_Limit, organization_emails, cscript_mxn_field, email_storage_trigger_resync, wizards, email_storage_phase2, functions_minimum_calls, voc_inventory, external_share_record, email_authentication, microsoft_teams, smart_prompt_googleai_llm, pages, wizard_cscript_transition_begin, best_time_to_contact, zia_vision, zoho_fsm, zia_summary, zoho_contracts, zia_summary_multilanguage_support, custom_field_url, sales_motivator_dashboards, detailview_canvasfiles, custom_field_phone, linkingmodule_custom_field_lookup, schedule_mail, mobilecanvas_kiosk_support, zia_sales_recommendation, business_card, shift_hours, instant_sync_cvid, CHATBOT_MULTILINGUAL, firstname_limit_increase, used_option_count, smart_prompt_in_cb, calendar_schedule_user_event, rfm_record_processing_count, linkingmodule_custom_field_url, path_finder_version_wise, unused_option_count, record_tags_count, emailConfigFeatures, zoho_expense, bounce_email, next_best_action, field_level_security, portal_personalitymodule, domain_mappings, custom_function_upgrade, gmail_rest_api, custom_field_check_box, talk_with_us_zoho_voice_call, email_workflow, intergration, sandbox, AUTOMATIC_ANOMALY_ENCH_2, notify_owner, mobiledetailview_customization, territory_management, custom_field_formula, copy_customization, form_rules_actions, functions_limits, scoring_rules, sales_signals_mobile_notification_support, custom_link, Stage_Total_Option_Count, inventory_management, accessibility, team_module_requester_settings, dxeditor_m1, email_templates, auto_response_rules, campaign_hierarchy_depth, sandbox_email_support, journey_limit_increase, Bundles__s, excluded_profiles, subform_allowed_file_limit, abm_product, MS_GRAPH_API, sales_motivator_dashboards_comp, zia_score_special_access, feeds_autofollowuprules_support, zoho_circuits_pricing, linkingmodule_custom_field_fileupload, email_duplication, linkingmodule_custom_field_percentage, webform_multidomain, bigin_dashboards_new_signup, abm_widget, zia_call_transcription_cops, email_credibility, scheduled_mass_email, emailparser, FormviewCustomization, custommodule, zcircuits_free_execution_per_month, orchestration_actions, homepage_report_components, BUSINESS_HOURS_SANDBOX, business_hours, pdf_sendmail_to_contacts, auto_responders, custom_field_small_text_area, zia_record_summary_special_access, orchestration_versions_wise, mail_merge, connected_workflows, multicurrency, zoho_invoice, file_storage_base, data_sharing_rules_criteria, linkingmodule_custom_field_decimal, waterfall, connected_records, web_multimodule_fields, ListviewCustomization, activity_badge_upgrade, abm_contact, record_level_sharing_indirect_groups, homepage_components, abm_plus, form_rules, services, mail_apps, validation_rule_custom_function, linkingmodule_custom_field_phone, payments_integration, cscript_reports, store_widget, custom_field_long_integer, workflow_rules_summary, chart, multipipelines, cscript_commands, REPORT_FORMULA_DYNAMIC_SELECT_LIMIT, text_case_intelligence, zoho_sign, voc_sales, zoho_mail, record_clone, multi_page_layout, input_options_gs, custom_ai_solutions, portal_users_store_widget, holidays, component_suggestion_early_access, cscript_dotsdk_new_flow, email_emotion_analysis, linkedIn_sales_navigator, chat_support, cscript_support_in_portals, custom_field_integer, subform_custom_field_large_text_area, custom_link_new_tab, recommendation_early_access_new_dc, custom_field_email, tiktok_leadchain, MS_21VIANET, webform_abtesting, abm_churn, telephony, large_global_set, mass_delete, portal_users, portal_authorizationmodule, form_rules_branch_criteria_per_condition, import, subform_custom_field_small_text_area, module_builder_new_ui, zoho_forms, subform_multiple_fileupload, ZOHOCPQ, abm_voc, team_module_requester_settings_disable, global_picklists, live_chat, zoho_support, calendar_schedule_team_event, zoho_circuits, encrypt_field, activity_calendar, disable_ecw_recipient, zia_call_analytics_automation, switch_edition, mb_lyte_qc_enabled, homeview_customization, Kiosk_GetRecords_Fetch, blueprint_states, calendar_schedule_team_call, funnel, subform_encrypt_field, subform_custom_field_text_area, CANVAS_BP_MANDATORY_CSCRIPT, zia_summary_special_access, ews_mailapps_integ, datahub, hamburger_menu_recommended_section, abm_account, twitter, smart_prompt_anthropic_llm_special_access, zcircuits_free_execution_per_user, sales_motivator_games_rules, Kiosk_Screen_Max_Buttons, quadrant, custom_reports, sentiment_analysis, webform analytics cleanup duration, system_address_field_enabled, custom_field_radio, criteria_entities_product_configurator, web_custommodule, CLIENTPORTAL_FOOTER_HIDING, zia_supported_deployment, zoho_bookings, price_rule_direct, blueprint_transitions, linkingmodule_custom_field_radiobutton, custom_field_currency, calendar_schedule_user, enable_record_state, form_rules_primary_condition, module_deleted_core_flow, call_transcription_early_access, emailsai_selfmarketing, disable_composer_default_spellcheck, zoho_showtime, schedule_mass_operation, emails_ai, Zoho_Docs, custom_field_cfpool_userlookup, gsearch_auto_complete, blueprint_transition_during_fields, google_calendar, cscript_preload, nextgenui_setuphome_enabled, guided_selling, emailFeatures, api_trigger_limit, smart_prompt_in_cb_special_access, visitor_tracking, mb_new_header, REPORT_FORMULA_DYNAMIC_CRITERIA_LIMIT, abm_deal, rename_tabs, cscript_subform_row_lock_function, notes_badge_listview, smart_prompt_cohere_llm, validation_rules, zia_conversation_summary_special_access, subform_module_max_rows_crud, linkingmodule_custom_field_decision_box, zone, bigin_dashboards_enabled, global_picklist_per_module, ear_for_email, external_field, cscript_multiuserlookup_field, rules_limit_per_module, marketplace, linkingmodule_custom_field_text_area, portal_users_new, Translation_Workbench, dynamic_lookup_filter, subform, linkingmodule_custom_field_text, homepage_quick_link_components, validation_rule_primary_condition, forecasts, mobilecanvas_navigator, automation_new_massmail_sources_enabled, Kiosk_Draft_Execution, Lyte_Stage_Probability_Mapping, cpq_dashboard_v2_2_support, hide_unauthorized_create_link, best_time_analytics_segmentation_access, copy_customization_interdc, custom_function_schedulers, custom_field_decimal, change_owner, appsspace_enabled, portal_parentmodule, business_messages, macros_suggest, abm_data_enrichment, portal_user_list_page_landing, sales_motivator_tvchannels, similarity_early_access, email_templates_attachments_total_count, crm_widgets, notes_rich_text_support_disable, zia_copilot, workflow_rules_executeon_safieldupdate, team_module_enabled, mailmerge_email, cscript, Kiosk_Execution_Per_User, trend_analysis, ZRC, module_limit_per_process, zia_anomaly, lux, detailview_queries_association, event_meeting_config, canvas_clickto_ajaxedit, chart_view, office365, sample_feature_1, mailchimp, abm_mood_score, tags, event_participants_reminder, workflow_suggestion, c3, abm_rel_flow_demo, web_forms, blueprint_common_transitions, di_cases_access, zia_reminder, nbx_goal, private_fields, duplicate_image_detection_special_access, sales_motivator_games_teams, CANVAS_FILES_UDSDOWNLOAD, linkingmodule_custom_field_currency, mass_update_by_cvid, dynamic_groups_product_configurator, web_lead, participants_limit, best_time_analytics_early_access, zia_summary_multilanguage_support_special_access, smart_prompt_deepseek_llm_special_access, linkingmodule_custom_field_pick_list, custom_field, mapview_and_autosuggest, remote_sales_office, data_storage_limits_more_than_200_user, modules_prediction, stage, text_product_intelligence, zia_owner_recommendation, emailcatchAllFeatures, sales_motivator_games, action_entities_product_configurator, unique_field, teamdrive, deduplication_tool, target_meter, inventory_templates, google_docs, record_level_sharing_indirect_roles, record_locking_configurations, query_workbench, Map_Dependency_Fields, IS_MAKING_NOTES_RT_NULL_ENABLED, CHATBOT_QUERY_SUGGESTION, ms_calendar, custom_ai_studio, sandbox_partial_deployment, custom_field_percentage, best_time_analytics_special_access, data_migration, feeds_followed_records_support, custom_field_large_text_area, data_enrichment, people_enrichment, phonebridge, smart_prompt_anthropic_llm, canvas_grid_layout, customer_usage_data, cadences, custom_functions, bm_line_integration, sales_motivator, cohort, DT_Filter, portals_authorization_criteria_count, custom_field_mxn, compliance_settings, apiname_page_corruption_view_enabled, custom_field_picklist, best_mode_to_contact, leadchain, subform_max_rows_crud_v2, Kiosk_GetRecord_Selection_Limit_Fetch, nextgenui_enabled, form_rules_branch_condition, api_name_page_lyte, webform_analytics_revamp, zia_score, voc_dashboard_limit, linking_module, web_contact, question_pages_gs, ciscoteams, custom_field_lookup, price_rule, calendar_schedule_user_call, SHIFT_IMPORT, presentation_special_access, schedule_call, linkedin_leadchain, leads_prediction, CHATBOT_V2_SPECIAL_ACCESS, keyboard_shortcuts, subForm_configured_fields, free_data_backup, intelligent_character_recognition, ASKZIA_WORKFLOW_CREATION, ListviewFromImageToCanvas, recommendation, custom_list_views, custom_field_aggregate_fields, smart_prompt, zia_conversation_summary, field_encryption, CANVAS_SERVICE, canvas_detailview_rl_scope, approval_processes, notes_rich_text_support, pitch, tasks, team_spaces, anomaly_notifications_new, export_xlsx, query_associations, portals, pathfinder_instance_creation_limit, crm_variables, zoho_cliq, di_cases_access_ee, calendar_schedule_team_per_service, zoho_backstage, people_enrichment_isc, voc_computation_keyword_limit, subform_permissions, workflow_report, user_associations_module_users, mass_transfer, CHATBOT_NEW_UI_ENABLED, customize_setup, workflow_rules_executeon_sectionupdate, zia_copilot_language_support, zia_in_email, google_contacts, picklist_history_tracking, workflow_rules_executeon_fieldupdate, Kiosk_GetRecords, calendar_booking, abm_recommendation, unique_chk_for_contacts, portal_user_group_new_ui, webform_fields_limit, record_level_sharing_users, webhooks, abm_suggested_segments, subform_max_rows_crud, subform_v2, ListviewCanvasRulesLimit, workflow_rules, cscript_notes_events, teamspace_enabled, subform_module_max_rows_crud_v2, google_chat, send_mail, people_enrichment_extension_migration, zia_call_analytics, homepage_kiosk_components, custom_field_multi_select, dup_chk_preference, workflow, writing_assistant_special_access, voc_for_loweredition, notes_edit_delete_by_owner, abm_recommendation_kakfa_disable, abm_tour, booking_pages, duplicate_image_detection, workflow_rules_executeon_datetime, report_export_daily, call_transcription, AI_CREDITS, prediction, calendar_schedule_team, cscript_uploadfields_events, zia_voice, abm_segment_journey_limit, zoho_assist, cscript_subform_feild_set_visible_function, record_level_sharing_roles, relay_smtp_debug, nbx_goal_ui, customview_sandbox_support, macro, teammodule, multiselect_filter_options, assignment_rules, social, mailcollabview, presentation_dc, multicurrency_nf, total_validation_rules, Kiosk_Association_Limit_Per_Page, locking_rules, pathfinder_limit_increase, nbx_live_update, data_storage_per_user, email_in, custom_field_radio_button, schedule_reports, smart_prompt_siliconflow_llm, full_data_sandbox, subject_line_suggestion, workflow_time_based_actions, mass_update, zoho_webinar, workflow_rules_executeon_delete_plugin, salesinbox, text_call_intelligence, zoho_docs, emailsai_selfmarketing_phase2, voc_anonymous, excluded_fields, voc_primary, abm_engagement_score, linkingmodule_custom_field, smart_prompt_special_access, executable_file_upload_restrict, pop_up_reminders, trends, custom_pages, send_mail_attachments_total_size, custom_field_auto_number, text_note_intelligence, zoho_pagesense, sales_motivator_rules, sales_motivator_tvchannels_comp, product_configurator, salesinbox_mobile, split_view_enabled, total_data_sharing_rules, google_instant_booking_profile, customization, mobile_apps, lead_conversion_layoutrule, smart_prompt_zia_llm_special_access, add_meeting, record_image, email_insights, path_finder, email, email_authorisation, zoho_survey, churn_prediction, assign_owner, report_aggregates_limit, custom_field_multi_select_multi_module_lookup, component_suggestion, dashboards_cache_reduced, prm_feature_enabled, Kiosk_Data_Hub, route_iq, price_rule_range, client_portal_saml_configuration, presentation, rfm_draft, linkingmodule_custom_field_small_text_area, linkingmodule_custom_field_check_box, canvas_flex_layout, sales_motivator_targets, crl_queries, feedback_mechanism, subform_permissions_disable, CSCRIPT_ORG_ZAPPS_RETRY, data_storage_per_user_more_than_200_user, admin_center, sales_motivator_teams_users, tab_groups, voc_component_limit, data_sharing_rules, subform_custom_field_pick_list, Lookup_Filter, records_limit, custom_field_userlookup, reports_scheduled, recommendation_for_workflow, case_escalation_rules, FORMULA_DYNAMIC_CRITERIA_LIMIT, workflow_rules_executeon_delete, zoho_sheet, zoho_flow_pricing, sky_eye, webform_analytics_url_revamp, linkingmodule_custom_field_large_text_area, linkingmodule_custom_field_integer, webform_suggestions, disable_sandbox_emailconsumer, smart_prompt_cohere_llm_special_access, similarity, schedules, field_prevent_duplicate, zoho_creator, zia_score_automation, email_storage, assignment_thresholds, facebook_leadchain, inc_used_option_count, subform_custom_field, listview_queries_association, cv_anomaly, user_associations_admin_users, reporting_hierarchy, smart_filters_limit, integration_email, subform_bulk_addition_max_rows, custom_field_text, smart_prompt_new_bot_v2_special_access, zia_record_summary, sales_signals, rfm_segmentation, form_rules_picklist_values_overall, data_sharing, zoho_flow, blueprints, user_type, zia, validation_rule_branch_condition, record_state_options_limit, booking_event_participant_limit, smart_prompt_googleai_llm_special_access, module_summary, search_layout, Competitors_Alert, marketing_attribution, abm_limit_enhancement, nextgenui_user_settings_preference, catalyst_solutions, EXTERNAL_MODULE_CONFIG, gmail, best_time_analytics, custom_field_fileupload, record_level_sharing, multiple_kanban_view, audit_logs, Closure_Restrictions, linkingmodule_custom_field_multi_select, functions_call_per_user, zia_scoring_rule_special_access, zia_pitch_special_access, mailbox_mails_population, additional_pipelines, text_meeting_intelligence, chatbot, facebook, user_associations, custom_field_multiuserlookup, smart_prompt_new_bot_v2, CSCRIPT_PAGES_MIGRATION, bigin_dashboards_enabled_trigger, caldav, smart_prompt_deepseek_llm, zia_field_creation, zoho_circuits_execution, custom_field_rich_text, custom_button, linkingmodule_custom_field_datetime, reminders, review_process, zcircuits_max_execution_per_month, RELATED_LIST_FIELDS, sales_motivator_teams, smart_prompt_siliconflow_llm_special_access, revert_connected_records, dashboards_enabled, CHATBOT_DETAIL_VIEW, report_export_records_limit, webform_analytics, Bundle_Product_Relations__s, email_sending_restriction, kpi, events_notification_mail, profiles, record_level_sharing_indirect_users, recommendation_early_access, text_email_intelligence, colourcode_option_count, fx_mics, custom_field_cfpool_lookup, sandbox_data_population_modules, CanvasRevisions, email_sharing, kanban_view, static_resource, connected_records_for_org_modules, CANVAS_LV_CSCRIPT, linkedin, presentation_early_access, custom_field_address_field, file_cabinet, m360_newmail_queue, custom_button_in_zia_widgets, zoho_campaigns_create, lead_chain, form_rules_picklist_values_per_condition, groups, email_attachments, microsoft_outlook, zia_call_audio_transcription, gamification, prediction_analytics, zoho_subscription, email_analytics, ZIA_DASHBOARD_COMPANION, cscript_subform_events, linkingmodule_custom_field_email, restricted_custom_buttons, zoho_lens
query.include	string	Optional	Maximum length: 3000 Pattern: ^(custom_view|related_lists|business_card_fields|layouts|fields)(,(custom_view|related_lists|business_card_fields|layouts|fields))*$
query.fields	array	Optional	Maximum items: 100
query.fields[]	string	Each item	Specifies the properties to include in the response Maximum length: 255

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Response body containing the array of module metadata objects. Additional keys: not allowed
$ (anyOf 1).modules	array	Required within parent	Array of module metadata objects returned for the Zoho CRM account, up to 600 entries, each containing configuration, capabilities, fields, layouts, profiles, and permissions. Maximum items: 600
$ (anyOf 1).modules[]	object	Each item	Complete metadata for a single Zoho CRM module, including configuration, capabilities, fields, layouts, profiles, and related lists. Additional keys: not allowed
$ (anyOf 1).modules[].access_type	string	Optional	Access control type for the module; `org_based` grants organization-wide access and `team_based` grants team-specific access. This value is immutable after module creation and cannot be updated via PUT operations. Known values: org_based, team_based
$ (anyOf 1).modules[].actual_plural_label	string	Optional	Original plural label of the module as stored in the database, without any translation applied. Maximum length: 50
$ (anyOf 1).modules[].actual_singular_label	string	Optional	Original singular label of the module as stored in the database, without any translation applied. Maximum length: 50
$ (anyOf 1).modules[].api_name	string	Optional	Unique API identifier for the module used in third-party integrations; starts with a letter, contains only alphanumeric characters and underscores, and has no consecutive or trailing underscores. Maximum length: 50
$ (anyOf 1).modules[].api_supported	boolean	Optional	Whether API operations are supported for this module.
$ (anyOf 1).modules[].arguments	JSON	Optional
$ (anyOf 1).modules[].arguments (anyOf 1)	array	Alternative	Array of argument objects used to substitute dynamic parameters in web tab URLs; for example, `https://…&id=${Users.User Id}&name=${Users.First Name}`. Duplicates are allowed, up to 50 entries. Maximum items: 50
$ (anyOf 1).modules[].arguments (anyOf 1)[]	Model	Each item	Expand Retrieve modules — response body — modules modules item arguments null item
$ (anyOf 1).modules[].arguments (anyOf 2)	null	Alternative	Array of argument objects used to substitute dynamic parameters in web tab URLs; for example, `https://…&id=${Users.User Id}&name=${Users.First Name}`. Duplicates are allowed, up to 50 entries. Maximum items: 50
$ (anyOf 1).modules[].arguments (anyOf 2)[]	Model	Each item	Expand Retrieve modules — response body — modules modules item arguments null item
$ (anyOf 1).modules[].business_card_field_limit	JSON	Optional
$ (anyOf 1).modules[].business_card_field_limit (anyOf 1)	integer	Alternative	Maximum number of fields that can be displayed on the business card view for this module; must be a non-negative integer. Format: int32 Minimum: 0
$ (anyOf 1).modules[].business_card_field_limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].cc_enabled	boolean	Optional	Whether CommandCenter functionality is enabled for email communications in this module; exposed only for orchestration modules and not applicable for API-supported modules.
$ (anyOf 1).modules[].convertable	boolean	Optional	Whether records in this module can be converted to another module type.
$ (anyOf 1).modules[].creatable	boolean	Optional	Indicates if new records can be created in this module.
$ (anyOf 1).modules[].deletable	boolean	Optional	Indicates whether records in this module can be deleted.
$ (anyOf 1).modules[].description	JSON	Optional
$ (anyOf 1).modules[].description (anyOf 1)	string	Alternative	User-defined description of the module, up to 255 characters; null when no description has been set. Maximum length: 255
$ (anyOf 1).modules[].description (anyOf 2)	null	Alternative	User-defined description of the module, up to 255 characters; null when no description has been set. Maximum length: 255
$ (anyOf 1).modules[].editable	boolean	Optional	Whether records in this module can be edited by users.
$ (anyOf 1).modules[].emailTemplate_support	boolean	Optional	Indicates whether Email Templates functionality is supported for this module.
$ (anyOf 1).modules[].email_parser_supported	boolean	Optional	Indicates whether email parsing is supported for this module.
$ (anyOf 1).modules[].feeds_required	boolean	Optional	Indicates whether activity feeds are required for this module.
$ (anyOf 1).modules[].filter_supported	boolean	Optional	Indicates whether records in this module can be filtered.
$ (anyOf 1).modules[].generated_type	string	Optional	Method by which this module was generated or created. Known values: field_tracker, default, web, linking, custom, picklisttracker, subform, static_subform, webtab_link
$ (anyOf 1).modules[].global_search_supported	boolean	Optional	Indicates whether global search functionality is supported for this module.
$ (anyOf 1).modules[].has_more_profiles	boolean	Optional	Indicates whether more profiles exist beyond those returned in the current response.
$ (anyOf 1).modules[].id	string	Required within parent	Represents the unique identifier for the module. Format: int64
$ (anyOf 1).modules[].inventory_template_supported	boolean	Optional	Indicates whether inventory templates are supported for this module.
$ (anyOf 1).modules[].isBlueprintSupported	boolean	Optional	Indicates whether Blueprint (process automation) is supported for this module.
$ (anyOf 1).modules[].lookupable	boolean	Optional	Indicates whether this module can be used as a lookup target in other modules.
$ (anyOf 1).modules[].modified_by	JSON	Optional
$ (anyOf 1).modules[].modified_by (anyOf 1)	object	Alternative	User object representing the user who last modified the module. Additional keys: not allowed
$ (anyOf 1).modules[].modified_by (anyOf 1).id	string	Required within parent	Represents the unique identifier of the user who last modified the module. Format: int64
$ (anyOf 1).modules[].modified_by (anyOf 1).name	string	Required within parent	Represents the name of the user who last modified the module. Maximum length: 101
$ (anyOf 1).modules[].modified_by (anyOf 2)	null	Alternative	Null value indicating the module has never been modified.
$ (anyOf 1).modules[].modified_time	JSON	Optional
$ (anyOf 1).modules[].modified_time (anyOf 1)	string	Alternative	Timestamp of the most recent modification to the module, returned as a timezone-aware date-time string; null if the module has never been modified. Format: date-time
$ (anyOf 1).modules[].modified_time (anyOf 2)	null	Alternative	Timestamp of the most recent modification to the module, returned as a timezone-aware date-time string; null if the module has never been modified. Format: date-time
$ (anyOf 1).modules[].module_name	string	Optional	Represents the display name of the module. Maximum length: 50
$ (anyOf 1).modules[].module_type	string	Optional	Represents the type classification of the module; exposed only for pathfinder and orchestration modules. Possible values: `CONFIGURATION_ENTITIES`, `ENTITIES`. Known values: CONFIGURATION_ENTITIES, ENTITIES
$ (anyOf 1).modules[].parent_module	JSON	Optional
$ (anyOf 1).modules[].parent_module (anyOf 1)	object	Alternative	Reference to the parent module if this is a child or related module; an empty object `{}` for standalone modules, `null` in some cases, or an object with `api_name` and `id` for child modules. Additional keys: not allowed
$ (anyOf 1).modules[].parent_module (anyOf 1).api_name	string	Optional	Represents the API name of the parent module. Maximum length: 50
$ (anyOf 1).modules[].parent_module (anyOf 1).id	string	Optional	Represents the unique identifier of the parent module. Format: int64
$ (anyOf 1).modules[].parent_module (anyOf 2)	null	Alternative	Reference to the parent module if this is a child or related module; an empty object `{}` for standalone modules, `null` in some cases, or an object with `api_name` and `id` for child modules. Additional keys: not allowed
$ (anyOf 1).modules[].parent_module (anyOf 2).api_name	string	Optional	Represents the API name of the parent module. Maximum length: 50
$ (anyOf 1).modules[].parent_module (anyOf 2).id	string	Optional	Represents the unique identifier of the parent module. Format: int64
$ (anyOf 1).modules[].plural_label	string	Optional	Plural display label for the module; returns the translated label when translation is enabled, otherwise matches `actual_plural_label`. Maximum length: 50
$ (anyOf 1).modules[].presence_sub_menu	boolean	Optional	Indicates whether this module has a presence submenu option.
$ (anyOf 1).modules[].private_profile	JSON	Optional
$ (anyOf 1).modules[].private_profile (anyOf 1)	object	Alternative	Private profile configuration for the module, containing the profile identifier and name. Additional keys: not allowed
$ (anyOf 1).modules[].private_profile (anyOf 1).id	string	Required within parent	Unique identifier of the private profile associated with the module. Format: int64
$ (anyOf 1).modules[].private_profile (anyOf 1).name	string	Required within parent	Name of the private profile associated with the module. Maximum length: 101
$ (anyOf 1).modules[].private_profile (anyOf 2)	null	Alternative	Private profile configuration for the module, containing the profile identifier and name. Additional keys: not allowed
$ (anyOf 1).modules[].private_profile (anyOf 2).id	string	Required within parent	Unique identifier of the private profile associated with the module. Format: int64
$ (anyOf 1).modules[].private_profile (anyOf 2).name	string	Required within parent	Name of the private profile associated with the module. Maximum length: 101
$ (anyOf 1).modules[].profile_count	JSON	Optional
$ (anyOf 1).modules[].profile_count (anyOf 1)	integer	Alternative	Represents the number of profiles associated with this module; 0 indicates no profile assignments. Format: int32
$ (anyOf 1).modules[].profile_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].profiles	array	Optional	List of profiles that have permission to view this module; may be empty for certain module types, with up to 203 entries. Maximum items: 203
$ (anyOf 1).modules[].profiles[]	object	Each item	Represents the profile object containing the profile identifier and display name. Additional keys: not allowed
$ (anyOf 1).modules[].profiles[].id	string	Required within parent	Represents the unique identifier of the profile. Format: int64
$ (anyOf 1).modules[].profiles[].name	string	Required within parent	Represents the display name of the profile. Maximum length: 50
$ (anyOf 1).modules[].public_fields_configured	boolean	Optional	Indicates whether public fields have been configured for this module.
$ (anyOf 1).modules[].quick_create	boolean	Optional	Indicates whether the quick create form is available for this module.
$ (anyOf 1).modules[].recycle_bin_on_delete	boolean	Optional	Indicates whether deleted records are moved to the recycle bin instead of being permanently deleted.
$ (anyOf 1).modules[].scoring_supported	boolean	Optional	Indicates whether lead or record scoring functionality is supported for this module.
$ (anyOf 1).modules[].sequence_number	JSON	Optional
$ (anyOf 1).modules[].sequence_number (anyOf 1)	integer	Alternative	Represents the display order of the module in the navigation list. Format: int32
$ (anyOf 1).modules[].sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].show_as_tab	boolean	Optional	Indicates whether the module appears as a tab in the main navigation.
$ (anyOf 1).modules[].singular_label	string	Optional	Singular display label for the module; returns the translated label when translation is enabled, otherwise matches `actual_singular_label`. Maximum length: 50
$ (anyOf 1).modules[].static_subform_properties	JSON	Optional
$ (anyOf 1).modules[].static_subform_properties (anyOf 1)	object	Alternative	Configuration properties for static subform modules, including the list of field references. Additional keys: not allowed
$ (anyOf 1).modules[].static_subform_properties (anyOf 1).fields	array	Required within parent	Array of field references included in the static subform, up to 25 entries. Maximum items: 25
$ (anyOf 1).modules[].static_subform_properties (anyOf 1).fields[]	object	Each item	Represents the field reference object containing the field API name and unique identifier. Additional keys: not allowed
$ (anyOf 1).modules[].static_subform_properties (anyOf 1).fields[].api_name	string	Required within parent	Represents the API name of the static subform field. Maximum length: 50
$ (anyOf 1).modules[].static_subform_properties (anyOf 1).fields[].id	string	Required within parent	Represents the unique identifier of the static subform field. Format: int64
$ (anyOf 1).modules[].static_subform_properties (anyOf 2)	null	Alternative	Configuration properties for static subform modules, including the list of field references. Additional keys: not allowed
$ (anyOf 1).modules[].static_subform_properties (anyOf 2).fields	array	Required within parent	Array of field references included in the static subform, up to 25 entries. Maximum items: 25
$ (anyOf 1).modules[].static_subform_properties (anyOf 2).fields[]	object	Each item	Represents the field reference object containing the field API name and unique identifier. Additional keys: not allowed
$ (anyOf 1).modules[].static_subform_properties (anyOf 2).fields[].api_name	string	Required within parent	Represents the API name of the static subform field. Maximum length: 50
$ (anyOf 1).modules[].static_subform_properties (anyOf 2).fields[].id	string	Required within parent	Represents the unique identifier of the static subform field. Format: int64
$ (anyOf 1).modules[].status	string	Optional	Lifecycle state of the module. Possible values: `visible`, `user_hidden`, `system_hidden`, `scheduled_for_deletion`. This status is separate from the numeric bitwise `visibility` flags. It does not itself enable/disable individual features. Known values: visible, scheduled_for_deletion, user_hidden, system_hidden
$ (anyOf 1).modules[].sub_menu_available	boolean	Optional	Whether a submenu is available for this module in the navigation.
$ (anyOf 1).modules[].territory	JSON	Optional
$ (anyOf 1).modules[].territory (anyOf 1)	object	Alternative	Territory assignment for the module, containing the territory identifier, name, and subordinates flag. Additional keys: not allowed
$ (anyOf 1).modules[].territory (anyOf 1).id	string	Required within parent	Unique identifier of the territory; 0 indicates the special “All Territories” territory. Format: int64
$ (anyOf 1).modules[].territory (anyOf 1).name	string	Required within parent	Name of the territory; for example, “All Territories” when the ID is 0. Maximum length: 100
$ (anyOf 1).modules[].territory (anyOf 1).subordinates	boolean	Required within parent	Whether subordinate territories are included in this territory assignment.
$ (anyOf 1).modules[].territory (anyOf 2)	null	Alternative	Territory assignment for the module, containing the territory identifier, name, and subordinates flag. Additional keys: not allowed
$ (anyOf 1).modules[].territory (anyOf 2).id	string	Required within parent	Unique identifier of the territory; 0 indicates the special “All Territories” territory. Format: int64
$ (anyOf 1).modules[].territory (anyOf 2).name	string	Required within parent	Name of the territory; for example, “All Territories” when the ID is 0. Maximum length: 100
$ (anyOf 1).modules[].territory (anyOf 2).subordinates	boolean	Required within parent	Whether subordinate territories are included in this territory assignment.
$ (anyOf 1).modules[].track_current_data	boolean	Optional	Whether current data tracking is enabled for this module.
$ (anyOf 1).modules[].triggers_supported	boolean	Optional	Whether workflow triggers are supported for this module.
$ (anyOf 1).modules[].viewable	boolean	Optional	Whether records in this module can be viewed.
$ (anyOf 1).modules[].visibility	JSON	Optional
$ (anyOf 1).modules[].visibility (anyOf 1)	integer	Alternative	Bitwise feature visibility flags for the module; the base value 1 indicates fully visible. Add flag values to hide specific features: 2=WEBUIHIDDEN, 4=TABMENU, 8=LOOKUP, 16=RELATEDLIST, 32=MULTISELECTLOOKUP, 64=MODULE_SETTING, 128=AUTOMATION, 256=TEMPLATES, 512=IMPORT, 1024=EXPORT, 4096=REPORT, 8192=API. Format: int32
$ (anyOf 1).modules[].visibility (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].web_link	JSON	Optional
$ (anyOf 1).modules[].web_link (anyOf 1)	string	Alternative	URL for web tab modules; supports dynamic parameter substitution via the arguments array.
$ (anyOf 1).modules[].web_link (anyOf 2)	null	Alternative	URL for web tab modules; supports dynamic parameter substitution via the arguments array.
$ (anyOf 1).modules[].webform_supported	boolean	Optional	Whether webform integration is supported for this module.
$ (anyOf 2)	null	Alternative

Referenced models: Retrieve modules — response body — modules modules item arguments null item

Schemas

Retrieve modules — response body — modules modules item arguments null item

Field	Type	Presence	Description and constraints
$	object	Root	Argument object that defines a URL parameter substitution, with a name (template key) and a value (field reference expression). Additional keys: not allowed
name	string	Required within parent	Key used in the web tab URL template to identify the substitution parameter. Maximum length: 50
value	string	Required within parent	Field substitution reference expression (for example, `users.recordId`) resolved at runtime for web tab URL parameter substitution. Maximum length: 100

Policy, approvals and errors

SDK function policy ID: zoho.getmodules. Catalog operation: getModules. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source