younifyd
Menu

Get module metadata by API name

Get module metadata by API name

GET/settings/modules/{moduleIdentifier}

Use it in a workflow

  1. Add a step and choose the Zoho CRM connector.
  2. Pick the Get module metadata by API name action (under Metadata).
  3. Fill in the fields below, then reference the result from later steps as {{getModuleMetadataByApiName.response.data}}.

Request

Path parameters

moduleIdentifieroneOfrequired

Specify the module identifier, either the numeric module ID or the module API name(case-sensitive).

Query parameters

fieldsarray<string>

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

include_inner_detailsstring

Specify the nested field paths to include additional inner details in the module response. Accepts comma-separated values. Allows requesting extra metadata beyond the default module fields(for example fields.lookup.query_details.criteria.)

Response

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

modulesarray<object>

Array of module metadata objects returned for the specified API name. Contains at most one element, as each API name maps to a single module.

global_search_supportedboolean

True when records in this module appear in global search results; false when the module is excluded from global search.

public_fields_configuredboolean

True when public fields have been configured for this module.

recycle_bin_on_deleteboolean

True when deleted records are moved to the recycle bin instead of being permanently deleted.

has_more_profilesboolean

True when the profiles array is truncated and additional profiles exist beyond those returned (pagination indicator); false when the full profile list is included.

sub_menu_availableboolean

True when a submenu is available for this module in the UI navigation

lookupableboolean

True when this module can be targeted as a lookup field by other modules.

profile_countinteger (int32)

Count of profiles assigned to this module; 0 indicates no profile assignments are configured. Maximum 203 profiles per module.

module_typestring

Categorizes the module as ENTITIES for standard data modules or CONFIGURATION_ENTITIES for configuration and settings modules.

One ofCONFIGURATION_ENTITIESENTITIES

cc_enabledboolean

True when CommandCenter (workflow orchestration) is enabled for this module; false when not configured or unsupported.

deletableboolean

True when records in this module can be permanently deleted; false for protected modules such as configuration entities or system-managed records.

descriptionstring | null

User-defined description of the module. Null when no description has been set. Maximum 255 characters; empty string should not be used.

sourcestring

Origin of the module configuration. Possible values: crm - native CRM module; platform_plugin - module from a platform plugin; marketplace_plugin - module from a marketplace plugin; campaign_integration - module created via campaign integration

One ofcrmplatform_pluginmarketplace_plugincampaign_integration

creatableboolean

True when new records can be created in this module; false for read-only modules such as analytics or configuration entities.

inventory_template_supportedboolean

True when inventory templates (e.g., for quotes, invoices) can be configured for this module; false when not supported.

modified_timestring | null

ISO 8601 timestamp with timezone offset recording when the module configuration was last modified. Null when the module has never been modified after creation.

presence_sub_menuboolean

True when the presence submenu is available for this module.

triggers_supportedboolean

True when workflow triggers are supported for this module

idstring (int64)required

Unique numeric identifier (as string) for this module. Required field; used as the stable reference across all API operations.

api_namestring

Case-sensitive API name used to reference this module in API requests (e.g., 'Leads', 'Contacts', 'CustomModule1').

plural_labelstring

Localized plural display label for the module as shown in the UI, reflecting the active language setting. Maximum 50 characters.

actual_plural_labelstring

System-level plural label for the module as stored in the database, representing the untranslated base value. Maximum 50 characters.

actual_singular_labelstring

System-level singular label for the module as stored in the database, representing the untranslated base value. Maximum 50 characters.

singular_labelstring

Localized singular display label for the module, up to 50 characters

isBlueprintSupportedboolean

True when Blueprint process automation can be configured for this module; false when Blueprint is not available for this module type.

visibilityinteger (int32)

Bitwise integer flags controlling module and feature visibility, ranging from 1 to 16383. Base value 1 means fully visible. Add flag values to suppress specific UI surfaces: 2=web UI hidden, 4=tab menu, 8=lookup, 16=related list, 32=multi-select lookup, 64=module settings, 128=automation, 256=templates, 512=import, 1024=export, 4096=reports, 8192=API.

convertableboolean

True when records in this module can be converted to records in another module (e.g., Leads to Contacts/Accounts).

editableboolean

True when existing records in this module can be edited by users with appropriate permissions; false for read-only modules.

emailTemplate_supportboolean

True when email templates can be used to send emails from records in this module; false when email template functionality is not supported.

email_parser_supportedboolean

True when email parsing is supported for this module, enabling automatic record creation or updates from inbound emails.

filter_supportedboolean

True when this module supports custom view filtering; false for modules that do not allow filter configuration.

show_as_tabboolean

True when this module is rendered as a tab in the navigation UI

web_linkstring | null

URL associated with this module; null when no web link is configured

viewableboolean

True when records in this module can be viewed by the current user

api_supportedboolean

True when the module is accessible via the Zoho CRM API; false for modules that are not externally queryable through API endpoints.

quick_createboolean

True when quick create functionality is enabled for this module.

generated_typestring

Classification of how this module was generated. Possible values: default - standard system module; custom - user-created module; web - web tab module; linking - many-to-many linking module; subform - dynamic subform module; static_subform - static subform; field_tracker - field change tracker; picklisttracker - picklist change tracker.

One offield_trackerdefaultweblinkingcustompicklisttrackersubformstatic_subform

static_subform_propertiesobject1 fields

Static subform configuration properties defined for fields within this module

feeds_requiredboolean

True when activity feeds are enabled for this module, displaying a timeline of record activities and updates.

scoring_supportedboolean

True when lead or contact scoring is supported for this module

webform_supportedboolean

True when web forms can be created for this module

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.