Modules APIs

Zoho CRM has standard modules such as, Leads, Accounts, Contacts, Deals, Forecasts, Activities, etc,. Using Zoho CRM REST API, you can retrieve the list of available modules as shown in the examples below:

Get list of modules

Purpose

To get the module related data. This will retrieve the list of modules available in your CRM account.

Request URL

https://www.zohoapis.com/crm/v2/settings/modules

Request Method

GET

Scope

scope=ZohoCRM.settings.all
(or)
scope=ZohoCRM.settings.modules.{operation_type}

Possible operation types
ALL - Full data access
READ - Get module data

Attributes

  • "convertable": Describes if the user can convert the record into another type of record. For example: Convert Leads into Deals.

  • "creatable": Checks if the user can create a record in the current module.

  • "generated_type": Describes the type of module which would be generated by the user. There are 4 types: default, web, custom, and linking.

  • "api_supported": The modules which are currently not accessible by APIs have value as "false". If the modules are supported in the future, the value automatically changes to "true".

  • "modified_time": The date and time at which the user has made a change.

Note:
  • Refer the key api_name in the JSON data while accessing the resource. Every module, field and related lists will have an API name, which you can use in third party integrations. For example, if you want to access the Leads module, use “Leads" as the api_name every time you access the resource. Zoho CRM generates API name internally while creating a custom module, custom field or related list label. Please note that you cannot alter the API Names for the default modules, fields, and related lists. You can change the API names only for custom modules, fields, and related lists.

  • The generated API name can contain only alphabets, numbers, and underscore. The API name should start with an alphabet and should not have two consecutive underscores or end with an underscore.

  • Refer Response Structure for more details about the JSON keys, values, and their descriptions of the available modules. You can also use the sample response of each module as the input when you insert, update, or upsert a record in that corresponding module.

Sample Request


				curl "https://www.zohoapis.com/crm/v2/settings/modules"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"			

Sample Response


				{
    "modules": [
       {
            "convertable": false,
            "editable": false,
            "deletable": false,
            "web_link": null,
            "singular_label": "Feeds",
            "modified_time": null,
            "viewable": true,
            "api_supported": false,
            "createable": false,
            "plural_label": "Feeds",
            "api_name": "Feeds",
            "modified_by": null,
            "generated_type": "default",
            "id": "410888000000059001",
            "module_name": "Feeds"
        },
       {
            "convertable": false,
            "editable": false,
            "deletable": false,
            "web_link": null,
            "singular_label": "Home",
            "modified_time": null,
            "viewable": true,
            "api_supported": false,
            "createable": false,
            "plural_label": "Home",
            "api_name": "Home",
            "modified_by": null,
            "generated_type": "default",
            "id": "410888000000000123",
            "module_name": "Home"
        },
       {
            "convertable": true,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Lead",
            "modified_time": "2016-07-29T13:19:14+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Leads",
            "api_name": "Leads",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000125",
            "module_name": "Leads"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Account",
            "modified_time": "2016-06-27T15:15:13+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Accounts",
            "api_name": "Accounts",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000127",
            "module_name": "Accounts"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Contact",
            "modified_time": "2016-04-29T12:45:09+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Contacts",
            "api_name": "Contacts",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000129",
            "module_name": "Contacts"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Potential",
            "modified_time": "2016-04-22T16:22:32+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Potentials",
            "api_name": "Potentials",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000131",
            "module_name": "Potentials"
        }
    ]
}			

Sample Request


				ZCRMRestClient client = ZCRMRestClient.getInstance();
BulkAPIResponse response = client.getAllModules();
List<ZCRMModule> modules = (List<ZCRMModule>) response.getData();			

Sample Response


				{
    "modules": [
       {
            "convertable": false,
            "editable": false,
            "deletable": false,
            "web_link": null,
            "singular_label": "Feeds",
            "modified_time": null,
            "viewable": true,
            "api_supported": false,
            "createable": false,
            "plural_label": "Feeds",
            "api_name": "Feeds",
            "modified_by": null,
            "generated_type": "default",
            "id": "410888000000059001",
            "module_name": "Feeds"
        },
       {
            "convertable": false,
            "editable": false,
            "deletable": false,
            "web_link": null,
            "singular_label": "Home",
            "modified_time": null,
            "viewable": true,
            "api_supported": false,
            "createable": false,
            "plural_label": "Home",
            "api_name": "Home",
            "modified_by": null,
            "generated_type": "default",
            "id": "410888000000000123",
            "module_name": "Home"
        },
       {
            "convertable": true,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Lead",
            "modified_time": "2016-07-29T13:19:14+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Leads",
            "api_name": "Leads",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000125",
            "module_name": "Leads"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Account",
            "modified_time": "2016-06-27T15:15:13+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Accounts",
            "api_name": "Accounts",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000127",
            "module_name": "Accounts"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Contact",
            "modified_time": "2016-04-29T12:45:09+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Contacts",
            "api_name": "Contacts",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000129",
            "module_name": "Contacts"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Potential",
            "modified_time": "2016-04-22T16:22:32+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Potentials",
            "api_name": "Potentials",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000131",
            "module_name": "Potentials"
        }
    ]
}			

Sample Request


				def get_modules(self):
        try:
            resp = ZCRMRestClient.get_instance().get_all_modules()
            modules = resp.data
            print (resp.status_code)
            for module in modules:
                print ("\n\n::MODULE::")
                print (module.api_name)
                print (module.is_convertable)
                print (module.is_creatable)
                print (module.is_editable)
                print (module.is_deletable)
                print (module.web_link)
                print (module.singular_label)
                print (module.plural_label)
                print (module.modified_by)
                print (module.modified_time)
                print (module.is_viewable)
                print (module.is_api_supported)
                print (module.is_custom_module)
                print (module.is_scoring_supported)
                print (module.id)
                print (module.module_name)
                print (module.business_card_field_limit)
                print (module.business_card_fields)
                profiles = module.profiles
                if profiles is not None:
                    for profile in profiles:
                        print (profile.name)
                        print (profile.id)
                print (module.display_field_name)
                print (module.display_field_id)
                if module.related_lists is not None:
                    for relatedlist in module.related_lists:
                        print (relatedlist.display_label)
                        print (relatedlist.is_visible)
                        print (relatedlist.api_name)
                        print (relatedlist.module)
                        print (relatedlist.name)
                        print (relatedlist.id)
                        print (relatedlist.href)
                        print (relatedlist.type)
                if module.layouts is not None:
                    for layout in module.layouts:
                        self.print_layout(layout)
                if module.fields is not None:
                    for field_ins in module.fields:
                        self.print_filed(field_ins)
                if module.related_list_properties is not None:
                    print (module.related_list_properties.sort_by)
                    print (module.related_list_properties.sort_order)
                    print (module.related_list_properties.fields)
                print (module.properties)
                print (module.per_page)
                print (module.search_layout_fields)
                print (module.default_territory_name)
                print (module.default_territory_id)
                print (module.default_custom_view_id)
                print (module.default_custom_view)
                print (module.is_global_search_supported)
                print (module.sequence_number)
        except ZCRMException as ex:
            print (ex.status_code)
            print (ex.error_message)
            print (ex.error_code)
            print (ex.error_details)
            print (ex.error_content)			

Sample Response


				{
    "modules": [
       {
            "convertable": false,
            "editable": false,
            "deletable": false,
            "web_link": null,
            "singular_label": "Feeds",
            "modified_time": null,
            "viewable": true,
            "api_supported": false,
            "createable": false,
            "plural_label": "Feeds",
            "api_name": "Feeds",
            "modified_by": null,
            "generated_type": "default",
            "id": "410888000000059001",
            "module_name": "Feeds"
        },
       {
            "convertable": false,
            "editable": false,
            "deletable": false,
            "web_link": null,
            "singular_label": "Home",
            "modified_time": null,
            "viewable": true,
            "api_supported": false,
            "createable": false,
            "plural_label": "Home",
            "api_name": "Home",
            "modified_by": null,
            "generated_type": "default",
            "id": "410888000000000123",
            "module_name": "Home"
        },
       {
            "convertable": true,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Lead",
            "modified_time": "2016-07-29T13:19:14+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Leads",
            "api_name": "Leads",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000125",
            "module_name": "Leads"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Account",
            "modified_time": "2016-06-27T15:15:13+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Accounts",
            "api_name": "Accounts",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000127",
            "module_name": "Accounts"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Contact",
            "modified_time": "2016-04-29T12:45:09+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Contacts",
            "api_name": "Contacts",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000129",
            "module_name": "Contacts"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Potential",
            "modified_time": "2016-04-22T16:22:32+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Potentials",
            "api_name": "Potentials",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000131",
            "module_name": "Potentials"
        }
    ]
}			

Sample Request


				try{
  $ins=ZCRMRestClient::getInstance();
  $moduleArr=$ins->getAllModules()->getData();
  foreach ($moduleArr as $module)
  {
  echo "ModuleName:".$module->getModuleName();
  echo "SingLabel:".$module->getSingularLabel();
  echo "PluLabel:".$module->getPluralLabel();
  echo "BusinesscardLimit:".$module->getBusinessCardFieldLimit();
  echo "ApiName:".$module->getAPIName();
  $fields=$module->getFields();
  if($fields==null)
  {
  continue;
  }
  foreach ($fields as $field)
  {
  echo $field->getApiName().", ";
  echo $field->getLength().", ";
  echo $field->IsVisible().", ";
  echo $field->getFieldLabel().", ";
  echo $field->getCreatedSource().", ";
  echo $field->isMandatory().", ";
  echo $field->getSequenceNumber().", ";
  echo $field->isReadOnly().", ";
  echo $field->getDataType().", ";
  echo $field->getId().", ";
  echo $field->isCustomField().", ";
  echo $field->isBusinessCardSupported().", ";
  echo $field->getDefaultValue().", ";
  }
  }
  }
  catch (ZCRMException $e)
  {
  echo $e->getCode();
  echo $e->getMessage();
  echo $e->getExceptionCode();
  }			

Sample Response


				{
    "modules": [
       {
            "convertable": false,
            "editable": false,
            "deletable": false,
            "web_link": null,
            "singular_label": "Feeds",
            "modified_time": null,
            "viewable": true,
            "api_supported": false,
            "createable": false,
            "plural_label": "Feeds",
            "api_name": "Feeds",
            "modified_by": null,
            "generated_type": "default",
            "id": "410888000000059001",
            "module_name": "Feeds"
        },
       {
            "convertable": false,
            "editable": false,
            "deletable": false,
            "web_link": null,
            "singular_label": "Home",
            "modified_time": null,
            "viewable": true,
            "api_supported": false,
            "createable": false,
            "plural_label": "Home",
            "api_name": "Home",
            "modified_by": null,
            "generated_type": "default",
            "id": "410888000000000123",
            "module_name": "Home"
        },
       {
            "convertable": true,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Lead",
            "modified_time": "2016-07-29T13:19:14+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Leads",
            "api_name": "Leads",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000125",
            "module_name": "Leads"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Account",
            "modified_time": "2016-06-27T15:15:13+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Accounts",
            "api_name": "Accounts",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000127",
            "module_name": "Accounts"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Contact",
            "modified_time": "2016-04-29T12:45:09+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Contacts",
            "api_name": "Contacts",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000129",
            "module_name": "Contacts"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Potential",
            "modified_time": "2016-04-22T16:22:32+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Potentials",
            "api_name": "Potentials",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000131",
            "module_name": "Potentials"
        }
    ]
}			

Sample Request


				ZCRMRestClient restClient = ZCRMRestClient.GetInstance();
BulkAPIResponse<ZCRMModule> response = restClient.GetAllModules();
List<ZCRMModule> modules = response.BulkData; // modules - list of ZCRMModule instances			

Sample Response


				{
    "modules": [
       {
            "convertable": false,
            "editable": false,
            "deletable": false,
            "web_link": null,
            "singular_label": "Feeds",
            "modified_time": null,
            "viewable": true,
            "api_supported": false,
            "createable": false,
            "plural_label": "Feeds",
            "api_name": "Feeds",
            "modified_by": null,
            "generated_type": "default",
            "id": "410888000000059001",
            "module_name": "Feeds"
        },
       {
            "convertable": false,
            "editable": false,
            "deletable": false,
            "web_link": null,
            "singular_label": "Home",
            "modified_time": null,
            "viewable": true,
            "api_supported": false,
            "createable": false,
            "plural_label": "Home",
            "api_name": "Home",
            "modified_by": null,
            "generated_type": "default",
            "id": "410888000000000123",
            "module_name": "Home"
        },
       {
            "convertable": true,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Lead",
            "modified_time": "2016-07-29T13:19:14+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Leads",
            "api_name": "Leads",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000125",
            "module_name": "Leads"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Account",
            "modified_time": "2016-06-27T15:15:13+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Accounts",
            "api_name": "Accounts",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000127",
            "module_name": "Accounts"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Contact",
            "modified_time": "2016-04-29T12:45:09+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Contacts",
            "api_name": "Contacts",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000129",
            "module_name": "Contacts"
        },
       {
            "convertable": false,
            "editable": true,
            "deletable": true,
            "web_link": null,
            "singular_label": "Potential",
            "modified_time": "2016-04-22T16:22:32+05:30",
            "viewable": true,
            "api_supported": true,
            "createable": true,
            "plural_label": "Potentials",
            "api_name": "Potentials",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "generated_type": "default",
            "id": "410888000000000131",
            "module_name": "Potentials"
        }
    ]
}