> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Zoho CRM: README
> Get module metadata by API name. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
Get module metadata by API name.
Tool ID: `zoho_crm_modules_get_module_by_api_name`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'zoho_crm_modules_get_module_by_api_name',
{
"moduleIdentifier": {}
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_modules_get_module_by_api_name --input '{
"moduleIdentifier": {}
}' --json
```
## Example response
The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get zoho_crm_modules_get_module_by_api_name --json` for the complete live contract.
## Input reference
Retrieves complete metadata for a specific CRM module identified by its API name. Returns comprehensive configuration including fields, layouts, profiles, related lists, custom views, and module capabilities.
| Name | Type | Required | Default | Details |
| -------------------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.moduleIdentifier` | `object` | Yes | — | Identifier for the module to retrieve, either numeric ID or API name. Use numeric ID for precise identification or API name for human-readable reference. Case-sensitive when using API name. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Retrieves complete metadata for a specific CRM module identified by its API name. Returns comprehensive configuration including fields, layouts, profiles, related lists, custom views, and module capabilities.",
"properties": {
"moduleIdentifier": {
"type": "object",
"description": "Identifier for the module to retrieve, either numeric ID or API name. Use numeric ID for precise identification or API name for human-readable reference. Case-sensitive when using API name.",
"additionalProperties": true
}
},
"required": [
"moduleIdentifier"
],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Module metadata response containing complete configuration details for the requested CRM module. |
| `result.data.modules` | `array` | Yes | — | Array containing module metadata. Typically contains a single module object for GET by api\_name. Maximum items: 1. |
| `result.data.modules[].global_search_supported` | `boolean` | Yes | — | Indicates whether this module supports global search functionality. |
| `result.data.modules[].public_fields_configured` | `boolean` | Yes | — | Indicates whether public fields have been configured for this module. |
| `result.data.modules[].recycle_bin_on_delete` | `boolean` | Yes | — | Indicates whether deleted records are moved to recycle bin instead of permanent deletion. |
| `result.data.modules[].has_more_profiles` | `boolean` | Yes | — | Indicates whether there are additional profiles beyond those returned in the response (pagination indicator). |
| `result.data.modules[].sub_menu_available` | `boolean` | Yes | — | Indicates whether this module has a submenu available in the UI. |
| `result.data.modules[].lookupable` | `boolean` | No | — | Indicates whether this module can be used as a lookup target by other modules. |
| `result.data.modules[].profile_count` | `integer` | Yes | — | Number of profiles available for this module. 0 indicates module has no profile assignments. Maximum 203 profiles per module. Format: `int32`. |
| `result.data.modules[].module_type` | `"CONFIGURATION_ENTITIES" \| "ENTITIES"` | No | — | Classification of the module - ENTITIES for standard data modules, CONFIGURATION\_ENTITIES for configuration/settings modules. Allowed: `CONFIGURATION_ENTITIES`, `ENTITIES`. |
| `result.data.modules[].cc_enabled` | `boolean` | No | — | Indicates whether CommandCenter functionality is enabled for this module. |
| `result.data.modules[].deletable` | `boolean` | Yes | — | Indicates whether records in this module can be deleted. |
| `result.data.modules[].description` | `string \| null` | Yes | — | User-defined description of the module. Null when no description has been set; empty string not used. |
| `result.data.modules[].source` | `"crm" \| "platform_plugin" \| "marketplace_plugin" \| "campaign_integration"` | No | — | Source or origin of the module configuration. Allowed: `crm`, `platform_plugin`, `marketplace_plugin`, `campaign_integration`. |
| `result.data.modules[].creatable` | `boolean` | No | — | Indicates whether new records can be created in this module. |
| `result.data.modules[].inventory_template_supported` | `boolean` | No | — | Indicates whether this module supports inventory template functionality. |
| `result.data.modules[].modified_time` | `string \| null` | No | — | Timestamp when the module configuration was last modified in ISO 8601 format with timezone offset (e.g., 2025-11-20T14:30:00+05:30). Null for modules never modified after initial creation. Format: `date-time`. |
| `result.data.modules[].presence_sub_menu` | `boolean` | No | — | Indicates whether presence submenu is available for this module. |
| `result.data.modules[].triggers_supported` | `boolean` | No | — | Indicates whether workflow triggers are supported for this module. |
| `result.data.modules[].id` | `string` | Yes | — | Unique identifier for the module. Format: `int64`. |
| `result.data.modules[].api_name` | `string` | No | — | API name used to reference this module in API calls. Maximum length: 50. |
| `result.data.modules[].plural_label` | `string` | No | — | Translated/localized plural display label for the module. Maximum length: 25. |
| `result.data.modules[].actual_plural_label` | `string` | No | — | Database/system plural label (untranslated base value) for the module. Maximum length: 25. |
| `result.data.modules[].actual_singular_label` | `string` | No | — | Database/system singular label (untranslated base value) for the module. Maximum length: 25. |
| `result.data.modules[].singular_label` | `string` | No | — | Translated/localized singular display label for the module. Maximum length: 25. |
| `result.data.modules[].isBlueprintSupported` | `boolean` | No | — | Indicates whether Blueprint (process automation) is supported for this module. |
| `result.data.modules[].visibility` | `integer` | No | — | Bitwise feature visibility flags controlling module and feature visibility. Base value 1=VISIBLE (fully visible). Add flag values to hide 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. Examples: 1=fully visible, 4612 (4+512+4096)=hides TabMenu+Import+Report, 14316=complex combination hiding multiple features. Format: `int32`. Minimum: 1. Maximum: 16383. |
| `result.data.modules[].convertable` | `boolean` | No | — | Indicates whether records in this module can be converted to other module records. |
| `result.data.modules[].editable` | `boolean` | No | — | Indicates whether records in this module can be edited. |
| `result.data.modules[].emailTemplate_support` | `boolean` | No | — | Indicates whether email templates are supported for this module. |
| `result.data.modules[].email_parser_supported` | `boolean` | No | — | Indicates whether email parsing functionality is supported for this module. |
| `result.data.modules[].filter_supported` | `boolean` | No | — | Indicates whether filtering/custom views are supported for this module. |
| `result.data.modules[].show_as_tab` | `boolean` | No | — | Indicates whether this module is displayed as a tab in the UI. |
| `result.data.modules[].web_link` | `string \| null` | No | — | Web link/URL associated with the module, if any. |
| `result.data.modules[].viewable` | `boolean` | No | — | Indicates whether records in this module can be viewed. |
| `result.data.modules[].api_supported` | `boolean` | No | — | Indicates whether this module is accessible via API. |
| `result.data.modules[].quick_create` | `boolean` | No | — | Indicates whether quick create functionality is available for this module. |
| `result.data.modules[].generated_type` | `"field_tracker" \| "default" \| "web" \| "linking" \| "custom" \| "picklisttracker" \| "subform" \| "static_subform"` | No | — | Type indicating how the module was generated - default for system modules, custom for user-created, subform for related subforms, etc. Allowed: `field_tracker`, `default`, `web`, `linking`, `custom`, `picklisttracker`, `subform`, `static_subform`. |
| `result.data.modules[].static_subform_properties` | `object` | No | — | Configuration for static subform fields within this module. |
| `result.data.modules[].static_subform_properties.fields` | `array` | Yes | — | Array of field references in the static subform Maximum items: 1000. |
| `result.data.modules[].static_subform_properties.fields[].api_name` | `string` | Yes | — | API name of the field Maximum length: 50. |
| `result.data.modules[].static_subform_properties.fields[].id` | `string` | Yes | — | Unique identifier of the field Format: `int64`. |
| `result.data.modules[].feeds_required` | `boolean` | No | — | Indicates whether activity feeds are required/enabled for this module. |
| `result.data.modules[].scoring_supported` | `boolean` | No | — | Indicates whether lead/contact scoring is supported for this module. |
| `result.data.modules[].webform_supported` | `boolean` | No | — | Indicates whether web forms can be created for this module. |
| `result.data.modules[].arguments` | `array` | No | — | Array of argument objects used to substitute parameters in web tab URLs (e.g., [https://...\&id=](https://...\&id=)${Users.User Id}&name=$\{Users.First Name}). Duplicates allowed; order preserved for multi-occurrence parameters. Empty for non-web-tab modules. Maximum items: 10. |
| `result.data.modules[].arguments[].name` | `string` | Yes | — | Argument key used in URL template. Maximum length: 50. |
| `result.data.modules[].arguments[].value` | `string` | Yes | — | Field substitution reference expression (e.g. users.recordId). Maximum length: 100. |
| `result.data.modules[].module_name` | `string` | No | — | System name of the module. Maximum length: 50. |
| `result.data.modules[].business_card_field_limit` | `integer` | No | — | Maximum number of fields that can be displayed in business card view for this module (non-negative). Format: `int32`. Minimum: 0. |
The table shows the first 50 fields. Use the live contract below for every field.
This output schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get zoho_crm_modules_get_module_by_api_name --json`.
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)