crm: Get Custom Module – Appmixer connector library

Basic Information

Name

appmixer.zoho.crm.GetCustomModule

Label

Get Custom Module

Version

1.0.0

Visibility

Public

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.

Input Ports

in

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

Output Ports

out

Field	Type	Description
ID	string	-
API Name	string	-
Module Name	string	-
Singular Label	string	-
Plural Label	string	-
Generated Type	string	-
Status	string	-
Visibility	integer	-
API Supported	boolean	-
Creatable	boolean	-
Editable	boolean	-
Deletable	boolean	-
Modified Time	string	-
Modified By	object	-

Full Metadata

#metadata-viewer { display: none; }{ "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:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjUwMCIgaGVpZ2h0PSI4NjQiIHZpZXdCb3g9IjAgMCA1MTIgMTc3IiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHByZXNlcnZlQXNwZWN0UmF0aW89InhNaWRZTWlkIj48ZGVmcz48bGluZWFyR3JhZGllbnQgeDE9IjQ5Ljk5NiUiIHkxPSIxLjQzMSUiIHgyPSI0OS45OTYlIiB5Mj0iOTYuOTgxJSIgaWQ9ImEiPjxzdG9wIHN0b3AtY29sb3I9IiNGRkU1MTMiIG9mZnNldD0iLjU2MiUiLz48c3RvcCBzdG9wLWNvbG9yPSIjRkRCOTI0IiBvZmZzZXQ9IjEwMCUiLz48L2xpbmVhckdyYWRpZW50PjxsaW5lYXJHcmFkaWVudCB4MT0iNC41MTIlIiB5MT0iMTMuNDk0JSIgeDI9Ijk1LjY3MiUiIHkyPSI4Ny4wNjQlIiBpZD0iYiI+PHN0b3Agc3RvcC1jb2xvcj0iIzAwOENEMiIgb2Zmc2V0PSIuNTYyJSIvPjxzdG9wIHN0b3AtY29sb3I9IiMwMDY0OUQiIG9mZnNldD0iMTAwJSIvPjwvbGluZWFyR3JhZGllbnQ+PGxpbmVhckdyYWRpZW50IHgxPSI1MC4wMDIlIiB5MT0iMjcuNzc5JSIgeDI9IjUwLjAwMiUiIHkyPSI5Ny41MjklIiBpZD0iYyI+PHN0b3Agc3RvcC1jb2xvcj0iIzI2QTE0NiIgb2Zmc2V0PSIwJSIvPjxzdG9wIHN0b3AtY29sb3I9IiMwMDhBNTIiIG9mZnNldD0iMTAwJSIvPjwvbGluZWFyR3JhZGllbnQ+PGxpbmVhckdyYWRpZW50IHgxPSI0My43MzQlIiB5MT0iOC4yMDglIiB4Mj0iNTcuNTQ0JSIgeTI9IjkzLjE5OCUiIGlkPSJkIj48c3RvcCBzdG9wLWNvbG9yPSIjRDkyMjMxIiBvZmZzZXQ9IjAlIi8+PHN0b3Agc3RvcC1jb2xvcj0iI0JBMjIzNCIgb2Zmc2V0PSIxMDAlIi8+PC9saW5lYXJHcmFkaWVudD48L2RlZnM+PHBhdGggZD0iTTUxMiAzNy43djEyMS40bC0xNi44IDE2LjRWNTYuN2wxNi44LTE5eiIgZmlsbD0iI0U3OTIyNSIvPjxwYXRoIGQ9Ik00MDEuOSAzNy44bC0xNy40IDE4LjkuOSAxLjIgMTA5LjEtLjQgMS0uOCAxNi41LTE5LTExMC4xLjF6IiBmaWxsPSIjRkZGMTZEIi8+PHBhdGggZmlsbD0idXJsKCNhKSIgZD0iTS41IDE5LjdoMTExdjExOC45SC41eiIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMzg0IDM3KSIvPjxwYXRoIGQ9Ik00NzguNiA5OS41Yy0yLjItNS41LTUuNS0xMC41LTkuOC0xNC44LTQuMS00LjItOC43LTcuNC0xMy45LTkuNS01LjEtMi4xLTEwLjYtMy4yLTE2LjYtMy4yLTYgMC0xMS42IDEuMS0xNi43IDMuMi01LjIgMi4xLTkuOCA1LjMtMTMuOSA5LjUtNC4zIDQuMy03LjUgOS4zLTkuNyAxNC44LTIuMiA1LjUtMy4yIDExLjUtMy4yIDE4LjEgMCA2LjQgMS4xIDEyLjQgMy4zIDE4IDIuMiA1LjYgNS40IDEwLjYgOS43IDE1IDQgNC4xIDguNiA3LjIgMTMuNyA5LjMgNS4xIDIuMSAxMC44IDMuMiAxNi45IDMuMiA1LjkgMCAxMS40LTEuMSAxNi41LTMuMnM5LjgtNS4yIDEzLjktOS4zYzQuMy00LjQgNy42LTkuNCA5LjgtMTQuOSAyLjItNS41IDMuMy0xMS42IDMuMy0xOCAwLTYuNy0xLjEtMTIuNy0zLjMtMTguMnptLTIyLjkgMzkuMmMtNC4zIDUuMS0xMCA3LjctMTcuNCA3LjctNy40IDAtMTMuMi0yLjYtMTcuNS03LjctNC4zLTUuMS02LjQtMTIuMi02LjQtMjEuMiAwLTkuMiAyLjItMTYuMyA2LjQtMjEuNSA0LjMtNS4yIDEwLTcuNyAxNy41LTcuNyA3LjQgMCAxMy4xIDIuNiAxNy40IDcuNyA0LjIgNS4yIDYuNCAxMi4zIDYuNCAyMS41IDAgOS0yLjEgMTYuMS02LjQgMjEuMnoiIGZpbGw9IiNGRkYiLz48Zz48cGF0aCBkPSJNMzczLjYgMjcuOHYuNmwxNC4yIDEwOS4xLTguMyAyMy0xLjEtLjgtMTQuNi0xMDQuNi4zLTEuNCA5LjEtMjUuMy40LS42eiIgZmlsbD0iIzAwOUFEQSIvPjxwYXRoIGQ9Ik0yNjQuMyA0M2wxMDkuMy0xNS4yLTkuMiAyNi4yLTEuMyAxLjQtMTAyLjIgMTUgLjUtMTguNyAyLjktOC43eiIgZmlsbD0iIzkxQzlFRCIvPjxwYXRoIGQ9Ik0xMDcuNCAyN2wxNS4xIDEwNi41LTEwNy43IDE1LjFMLjMgNDUuN2w2LjMtNC45TDEwNy40IDI3eiIgZmlsbD0idXJsKCNiKSIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMjU3IDI3KSIvPjxwYXRoIGQ9Ik0zNDYuMSA3NC40Yy0uNS0zLjMtMS42LTUuOC0zLjQtNy41LTEuNS0xLjMtMy4zLTItNS40LTItLjUgMC0xLjEgMC0xLjcuMS0yLjguNC00LjkgMS43LTYuMiAzLjgtMSAxLjUtMS40IDMuNC0xLjQgNS42IDAgLjguMSAxLjcuMiAyLjZsMy45IDI3LjctMzEgNC42LTMuOS0yNy43Yy0uNS0zLjItMS42LTUuNy0zLjQtNy40LTEuNS0xLjQtMy4zLTIuMS01LjMtMi4xLS41IDAtMSAwLTEuNS4xLTIuOS40LTUuMSAxLjctNi41IDMuOC0xIDEuNS0xLjQgMy40LTEuNCA1LjYgMCAuOC4xIDEuNy4yIDIuN2wxMC42IDcyLjFjLjUgMy4zIDEuNiA1LjggMy42IDcuNSAxLjUgMS4zIDMuMyAxLjkgNS41IDEuOS42IDAgMS4yIDAgMS44LS4xIDIuNy0uNCA0LjctMS43IDYtMy44LjktMS41IDEuMy0zLjMgMS4zLTUuNCAwLS44LS4xLTEuNy0uMi0yLjZsLTQuMy0yOC41IDMxLTQuNiA0LjMgMjguNWMuNSAzLjMgMS42IDUuOCAzLjUgNy40IDEuNSAxLjMgMy4zIDIgNS40IDIgLjUgMCAxLjEgMCAxLjctLjEgMi44LS40IDQuOS0xLjcgNi4yLTMuOC45LTEuNSAxLjQtMy4zIDEuNC01LjUgMC0uOC0uMS0xLjctLjItMi42bC0xMC44LTcyLjN6IiBmaWxsPSIjRkZGIi8+PC9nPjxnPjxwYXRoIGQ9Ik0xNjIgMGwtMzguOSA5Mi40IDUuMyA0MC42LjMtLjEgNDMuNy05OC4zLS4yLTIuMS05LjQtMzEuMkwxNjIgMHoiIGZpbGw9IiM2NkJGNkIiLz48cGF0aCBkPSJNMTYyIDBsMTAuMSAzMy45LjIuNyA5Ni4yIDQzLjEuMy0uMi04LjItMzIuNEwxNjIgMHoiIGZpbGw9IiM5OEQwQTAiLz48cGF0aCBkPSJNNDkuMSAzMy45bDk2LjcgNDMuNi00My43IDk5LjFMNS40IDEzM2w0My43LTk5LjF6IiBmaWxsPSJ1cmwoI2MpIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgxMjMpIi8+PHBhdGggZD0iTTIzOS41IDg1LjVjLTIuMS01LjYtNS0xMC40LTguOC0xNC40LTMuOC00LTguNC03LjItMTMuOC05LjVzLTEwLjgtMy40LTE2LjMtMy40aC0uM2MtNS42IDAtMTEuMSAxLjMtMTYuNSAzLjctNS43IDIuNS0xMC42IDUuOS0xNC44IDEwLjQtNC4yIDQuNC03LjYgOS44LTEwLjIgMTYtMi42IDYuMS00IDEyLjMtNC4zIDE4LjR2Mi4xYzAgNS40LjkgMTAuNyAyLjggMTUuOSAyIDUuNSA0LjkgMTAuMiA4LjcgMTQuMiAzLjggNCA4LjUgNy4yIDE0LjEgOS41IDUuMyAyLjMgMTAuNyAzLjQgMTYuMiAzLjRoLjFjNS41IDAgMTEtMS4yIDE2LjQtMy41IDUuNy0yLjUgMTAuNy02IDE0LjktMTAuNSA0LjItNC40IDcuNy05LjcgMTAuMy0xNS45IDIuNi02LjIgNC0xMi4zIDQuMy0xOC40di0xLjhjLjEtNS41LS44LTEwLjktMi44LTE2LjJ6bS0xOS4zIDI4LjhjLTMuNiA4LjYtOC41IDE0LjUtMTQuNCAxNy43LTMuMiAxLjctNi41IDIuNi05LjggMi42LTIuOSAwLTYtLjctOS4xLTItNi44LTIuOS0xMS03LjUtMTIuOC0xNC4xLS42LTIuMi0uOS00LjUtLjktNi45IDAtNC44IDEuMi0xMC4xIDMuNi0xNS44IDMuNy04LjggOC42LTE0LjggMTQuNS0xOC4xIDMuMi0xLjggNi41LTIuNiA5LjgtMi42IDMgMCA2IC43IDkuMiAyIDYuNyAyLjkgMTAuOSA3LjUgMTIuNyAxNC4xLjYgMi4xLjkgNC40LjkgNi44IDAgNS0xLjIgMTAuNC0zLjcgMTYuM3oiIGZpbGw9IiNGRkYiLz48L2c+PGc+PHBhdGggZD0iTTExNS40IDE1LjdsMTUuOCAxMDUuOC03LjIgMzcuMi0xLTEuMy0xNS40LTEwMi4ydi0ybDYuOC0zNS43IDEtMS44eiIgZmlsbD0iIzc2MEQxNiIvPjxwYXRoIGQ9Ik0wIDcwLjRMNy41IDMzbDEwNy45LTE3LjMtNy4zIDM4LjF2Mi41TDEuMyA3MS40bC0xLjMtMXoiIGZpbGw9IiNFRjQ2M0UiLz48cGF0aCBkPSJNMTA4LjEgMzguOEwxMjQgMTQzLjcgMTcuMiAxNjAuNCAwIDU1LjRsMTA4LjEtMTYuNnoiIGZpbGw9InVybCgjZCkiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDAgMTUpIi8+PHBhdGggZD0iTTk2LjYgMTQyYy0uOC0xLTItMS43LTMuNC0yLjItMS40LS41LTMuMS0uNy01LjItLjctMS45IDAtNC4xLjItNi41LjZsLTI4LjIgNC44Yy4zLTIuMiAxLjQtNSAzLjMtOC41IDIuMS0zLjkgNS4zLTguNiA5LjQtMTQgMS40LTEuOSAyLjUtMy4zIDMuMy00LjMuNS0uNyAxLjMtMS42IDIuMy0yLjkgNi41LTguNSAxMC40LTE1LjQgMTItMjAuOC45LTMuMSAxLjQtNi4yIDEuNi05LjMuMS0uOS4xLTEuNy4xLTIuNSAwLTIuMi0uMi00LjQtLjYtNi42LS4zLTItLjgtMy42LTEuNS00LjktLjctMS4zLTEuNS0yLjMtMi41LTIuOS0xLjEtLjctMi44LTEtNC45LTEtMS43IDAtMy44LjItNi4zLjZMMzYuOSA3M2MtMy45LjctNi45IDEuOC04LjcgMy42LTEuNSAxLjQtMi4yIDMuMi0yLjIgNS4yIDAgLjUgMCAxLjEuMSAxLjcuNSAyLjggMS45IDQuOCA0LjIgNS44IDEuNC42IDMgLjkgNSAuOSAxLjMgMCAyLjgtLjEgNC40LS40TDY2LjkgODVjMCAuNS4xIDEgLjEgMS40IDAgMS43LS4zIDMuNC0uOSA1LS44IDIuMy0yLjggNS41LTYuMSA5LjYtLjkgMS4xLTIuMyAyLjktNC4yIDUuMi03LjQgOC45LTEyLjYgMTYuNS0xNS44IDIyLjgtMi4zIDQuNC0zLjggOC42LTQuNyAxMi45LS41IDIuNS0uOCA0LjgtLjggNy4xIDAgMS42LjEgMy4yLjQgNC43LjQgMi4yLjkgNCAxLjYgNS40LjcgMS40IDEuNyAyLjUgMi44IDMuMSAxLjEuNiAyLjYuOCA0LjguOCAyLjcgMCA2LjQtLjQgMTEuMS0xLjJsMjkuNi01LjFjNS4yLS45IDguOS0yLjIgMTEtMy45IDEuNy0xLjQgMi42LTMuMyAyLjYtNS41IDAtLjYtLjEtMS4yLS4yLTEuOC0uMi0xLjMtLjctMi41LTEuNi0zLjV6IiBmaWxsPSIjRkZGIi8+PC9nPjwvc3ZnPg==" }