> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# Get Custom Module

- Component: `appmixer.zoho.crm.GetCustomModule`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.zoho.crm 2.4.5](https://connectors.appmixer.com/connector/appmixer.zoho.crm/2.4.5.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.zoho.crm/2.4.5/component/appmixer.zoho.crm.GetCustomModule>

Gets the metadata of a Zoho CRM module by its API name - labels, status and what the API allows to do with its records. Works for any module, custom or standard.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Module API Name (`moduleApiName`) | text | The API name of the module, e.g. "Service_Contracts". Find Custom Modules returns it as API Name. |

## Output ports

### Port `out`

| Field | Type | Description |
| --- | --- | --- |
| ID (`id`) | string | - |
| API Name (`api_name`) | string | - |
| Module Name (`module_name`) | string | - |
| Singular Label (`singular_label`) | string | - |
| Plural Label (`plural_label`) | string | - |
| Generated Type (`generated_type`) | string | - |
| Status (`status`) | string | - |
| Visibility (`visibility`) | integer | - |
| API Supported (`api_supported`) | boolean | - |
| Creatable (`creatable`) | boolean | - |
| Editable (`editable`) | boolean | - |
| Deletable (`deletable`) | boolean | - |
| Modified Time (`modified_time`) | string | - |
| Modified By (`modified_by`) | object | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.zoho.crm.GetCustomModule",
  "label": "Get Custom Module",
  "description": "Gets the metadata of a Zoho CRM module by its API name - labels, status and what the API allows to do with its records. Works for any module, custom or standard.",
  "author": "Appmixer <info@appmixer.com>",
  "version": "1.0.0",
  "auth": {
    "service": "appmixer:zoho",
    "scope": [
      "ZohoCRM.settings.modules.READ"
    ]
  },
  "quota": {
    "manager": "appmixer:zoho",
    "resources": "requests",
    "scope": {
      "userId": "{{userId}}"
    }
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "moduleApiName": {
            "type": "string"
          }
        },
        "required": [
          "moduleApiName"
        ]
      },
      "inspector": {
        "inputs": {
          "moduleApiName": {
            "type": "text",
            "label": "Module API Name",
            "index": 1,
            "tooltip": "The API name of the module, e.g. \"Service_Contracts\". Find Custom Modules returns it as API Name."
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "schema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "title": "ID",
            "example": "4876876000000834002"
          },
          "api_name": {
            "type": "string",
            "title": "API Name",
            "example": "Service_Contracts"
          },
          "module_name": {
            "type": "string",
            "title": "Module Name",
            "example": "CustomModule1"
          },
          "singular_label": {
            "type": "string",
            "title": "Singular Label",
            "example": "Service Contract"
          },
          "plural_label": {
            "type": "string",
            "title": "Plural Label",
            "example": "Service Contracts"
          },
          "generated_type": {
            "type": "string",
            "title": "Generated Type",
            "example": "custom"
          },
          "status": {
            "type": "string",
            "title": "Status",
            "example": "visible"
          },
          "visibility": {
            "type": "integer",
            "title": "Visibility",
            "example": 1
          },
          "api_supported": {
            "type": "boolean",
            "title": "API Supported",
            "example": true
          },
          "creatable": {
            "type": "boolean",
            "title": "Creatable",
            "example": true
          },
          "editable": {
            "type": "boolean",
            "title": "Editable",
            "example": true
          },
          "deletable": {
            "type": "boolean",
            "title": "Deletable",
            "example": true
          },
          "modified_time": {
            "type": "string",
            "title": "Modified Time",
            "example": "2026-08-28T16:40:00+00:00"
          },
          "modified_by": {
            "type": "object",
            "title": "Modified By",
            "properties": {
              "id": {
                "type": "string",
                "title": "Modified By.ID",
                "example": "4876876000000306001"
              },
              "name": {
                "type": "string",
                "title": "Modified By.Name",
                "example": "John Smith"
              }
            }
          }
        }
      }
    }
  ],
  "icon": "(data URI omitted)"
}
```
