younifyd
Menu

Retrieve modules

Retrieve modules

GET/settings/modules

Use it in a workflow

  1. Add a step and choose the Zoho CRM connector.
  2. Pick the Retrieve modules action (under Metadata).
  3. Fill in the fields below, then reference the result from later steps as {{retrieveModules.response.data}}.

Request

Query parameters

statusstring

Specify the visibility status to filter the modules returned in the response. Accepts comma-separated values to retrieve modules matching any of the specified statuses. This is case-sensitive.

feature_namestring

Specify the feature name to filter modules associated with a specific CRM feature.This is case-sensitive and follows snake_case format. An empty string returns 400 error

One ofKiosk_Test_Runsales_motivator_games_usersfunctionslinkingmodule_custom_field_long_integersmart_prompt_zia_llmvoc_parentlinkingmodule_custom_field_dataparammb_delete_limit_popupunsubscribequery_sourcesfield_updatescrl_queries_clickweb_casegoogle_instant_bookingemailsai_summary_translationASKZIA_MODULE_CREATIONstatic_subform_max_rowstriggerspublic_fieldcustom_field_datetimeextensionsmass_emailnextgenui_new_panel_enabledconnected_workflows_limitCANVAS_META_CACHE_REVERTERsend_mail_attachments_total_countdate_queriesproduction_trackingnbx_early_accesspicklist colour coding V2custom_field_dataparamteammodule_custom_fieldaddress_field_enableddata_storage_countprivacy_modulesemail_relaymanage_signalswizard_cross_screen_fields_in_criteriapage_layoutsample_subfeature_1

includestring

Specify the additional module metadata fields to include in the response. Accepts comma-separated values. Allows retrieving optional module metadata that is not returned by default.

fieldsarray<string>

Specify the module property names to include in the response. Accepts an array of property names to filter the returned module fields.

Response

Returns 200 with an object. Read it in later steps with {{retrieveModules.response.data.<field>}}.

modulesarray<object>

Array of module metadata objects returned for the Zoho CRM account, up to 600 entries, each containing configuration, capabilities, fields, layouts, profiles, and permissions.

global_search_supportedboolean

Indicates whether global search functionality is supported for this module.

public_fields_configuredboolean

Indicates whether public fields have been configured for this module.

recycle_bin_on_deleteboolean

Indicates whether deleted records are moved to the recycle bin instead of being permanently deleted.

has_more_profilesboolean

Indicates whether more profiles exist beyond those returned in the current response.

sub_menu_availableboolean

Whether a submenu is available for this module in the navigation.

lookupableboolean

Indicates whether this module can be used as a lookup target in other modules.

profile_countinteger (int32)

Represents the number of profiles associated with this module; 0 indicates no profile assignments.

module_typestring

Represents the type classification of the module; exposed only for pathfinder and orchestration modules. Possible values: `CONFIGURATION_ENTITIES`, `ENTITIES`.

One ofCONFIGURATION_ENTITIESENTITIES

cc_enabledboolean

Whether CommandCenter functionality is enabled for email communications in this module; exposed only for orchestration modules and not applicable for API-supported modules.

deletableboolean

Indicates whether records in this module can be deleted.

descriptionstring | null

User-defined description of the module, up to 255 characters; null when no description has been set.

creatableboolean

Indicates if new records can be created in this module.

inventory_template_supportedboolean

Indicates whether inventory templates are supported for this module.

modified_timestring | null

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.

presence_sub_menuboolean

Indicates whether this module has a presence submenu option.

triggers_supportedboolean

Whether workflow triggers are supported for this module.

idstring (int64)required

Represents the unique identifier for the module.

api_namestring

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.

plural_labelstring

Plural display label for the module; returns the translated label when translation is enabled, otherwise matches `actual_plural_label`.

actual_plural_labelstring

Original plural label of the module as stored in the database, without any translation applied.

actual_singular_labelstring

Original singular label of the module as stored in the database, without any translation applied.

singular_labelstring

Singular display label for the module; returns the translated label when translation is enabled, otherwise matches `actual_singular_label`.

isBlueprintSupportedboolean

Indicates whether Blueprint (process automation) is supported for this module.

visibilityinteger (int32)

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.

convertableboolean

Whether records in this module can be converted to another module type.

editableboolean

Whether records in this module can be edited by users.

emailTemplate_supportboolean

Indicates whether Email Templates functionality is supported for this module.

email_parser_supportedboolean

Indicates whether email parsing is supported for this module.

filter_supportedboolean

Indicates whether records in this module can be filtered.

show_as_tabboolean

Indicates whether the module appears as a tab in the main navigation.

web_linkstring | null

URL for web tab modules; supports dynamic parameter substitution via the arguments array.

viewableboolean

Whether records in this module can be viewed.

api_supportedboolean

Whether API operations are supported for this module.

quick_createboolean

Indicates whether the quick create form is available for this module.

generated_typestring

Method by which this module was generated or created.

One offield_trackerdefaultweblinkingcustompicklisttrackersubformstatic_subformwebtab_link

static_subform_propertiesobject | null1 fields

Configuration properties for static subform modules, including the list of field references.

feeds_requiredboolean

Indicates whether activity feeds are required for this module.

scoring_supportedboolean

Indicates whether lead or record scoring functionality is supported for this module.

webform_supportedboolean

Whether webform integration is supported for this module.

argumentsarray | null

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.

json
{
  "modules": [
    {
      "id": "string",
      "global_search_supported": false,
      "public_fields_configured": false,
      "recycle_bin_on_delete": false,
      "has_more_profiles": false,
      "sub_menu_available": false,
      "lookupable": false,
      "profile_count": 0,
      "module_type": "CONFIGURATION_ENTITIES",
      "cc_enabled": false,
      "deletable": false,
      "description": "string"
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.