getModules Method

    getModules Method

    Table of Contents

     Purpose

    You can use the getModules method to get the list of modules in your CRM account.

     Request URL

    XML Format:
    https://crm.zoho.com/crm/private/xml/Info/getModules?authtoken=Auth Token&scope=crmapi

    JSON Format:
    https://crm.zoho.com/crm/private/json/Info/getModules?authtoken=Auth Token&scope=crmapi 

     Request Parameters

    ParameterData TypeDescription
    authtoken*StringEncrypted alphanumeric string to authenticate your Zoho credentials. 
    scope*StringSpecify the value as crmapi.
    typeStringSpecify the value as api. This will return only the modules that are accessible via API.

    * - Mandatory parameter

    Note:

    • Refer the Release Notes  page to learn more about enhancements made in the API implementation.

     Sample Response

    <response uri="/crm/private/xml/Info/getModules">

    <result>
    <row no="1" id="xxxx000000002xxx" pl="Accounts" sl="Account" gt="1">Accounts</row>
    <row no="2" id="xxxx000000002xxx" pl="Contacts" sl="Contact" gt="1">Contacts</row>
    <row no="3" id="xxxx000000002xxx" pl="Registrations" sl="Customers" gt="4">CustomModule1</row>
    <row no="4" id="xxxx000000002xxx" pl="Potentials" sl="Potential" gt="1">Potentials</row>
    <row no="5" id="xxxx000000002xxx" pl="Activities" sl="Activity" gt="1">Activities</row>
    <row no="6" id="xxxx000000002xxx" pl="Campaigns" sl="Campaign" gt="1">Campaigns</row>
    <row no="7" id="xxxx000000002xxx" pl="Cases" sl="Case" gt="1">Cases</row>
    <row no="8" id="xxxx000000002xxx" pl="Leads" sl="Lead" gt="1">Leads</row>
    <row no="9" id="xxxx000000002xxx" pl="Social" sl="Social" gt="1">Social</row>
    <row no="11" id="xxxx000000002xxx" pl="Quotes" sl="Quote" gt="1">Quotes</row>
    <row no="12" id="xxxx000000002xxx" pl="Documents" sl="Documents" gt="1">Documents</row>
    <row no="13" id="xxxx000000002xxx" pl="Reports" sl="Reports" gt="1">Reports</row>
    <row no="14" id="xxxx000000002xxx" pl="Emails" sl="Email" gt="1">Emails</row>
    <row no="15" id="xxxx000000002xxx" pl="Products" sl="Product" gt="1">Products</row>
    </result>
    </response> 

    If type = api, the functionality and response will be as shown below:

    <response uri="/crm/private/xml/Info/getModules">
    <result>
    <row no="1" id="1757196000000002175" pl="Leads" sl="Lead" gt="1">Leads</row>
    <row no="2" id="1757196000000002177" pl="Accounts" sl="Account" gt="1">Accounts</row>
    <row no="3" id="1757196000000002179" pl="Contacts" sl="Contact" gt="1">Contacts</row>
    <row no="4" id="1757196000000002181" pl="Potentials" sl="Potential" gt="1">Potentials</row>
    <row no="5" id="1757196000000002193" pl="Tasks" sl="Task" gt="1">Tasks</row>
    <row no="6" id="1757196000000002195" pl="Events" sl="Event" gt="1">Events</row>
    <row no="7" id="1757196000000033015" pl="Calls" sl="Call" gt="1">Calls</row>
    <row no="8" id="1757196000000002213" pl="Products" sl="Product" gt="1">Products</row>
    <row no="9" id="1757196000000002183" pl="Campaigns" sl="Campaign" gt="1">Campaigns</row>
    <row no="10" id="1757196000000002209" pl="Cases" sl="Case" gt="1">Cases</row>
    <row no="11" id="1757196000000002211" pl="Solutions" sl="Solution" gt="1">Solutions</row>
    <row no="12" id="1757196000000002215" pl="Vendors" sl="Vendor" gt="1">Vendors</row>
    <row no="13" id="1757196000000002217" pl="Price Books" sl="Price Book" gt="1">PriceBooks</row>
    <row no="14" id="1757196000000002219" pl="Quotes" sl="Quote" gt="1">Quotes</row>
    <row no="15" id="1757196000000002221" pl="Sales Orders" sl="Sales Order" gt="1">SalesOrders</row>
    <row no="16" id="1757196000000002223" pl="Purchase Orders" sl="Purchase Order" gt="1">PurchaseOrders</row>
    <row no="17" id="1757196000000002225" pl="Invoices" sl="Invoice" gt="1">Invoices</row>
    </result>

    Share this post : FacebookTwitter

    Still can't find what you're looking for?

    Write to us: support@zohocrm.com