getModules Method

 Purpose

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

 Request URL

XML Format:
https://<APPDOMAIN>/crm/private/xml/Info/getModules?

JSON Format:
https://<APPDOMAIN>/crm/private/json/Info/getModules?

 Auth Token

Auth Token is an encrypted alphanumeric string that is required to authenticate your CRM account credentials. A valid user's Authentication Token is necessary to access the API. When making an API request, send the authentication token in the Authorization header as shown below:

https://<APPDOMAIN>/crm/private/xml/Info/getModules?

Header:

Authorization=1000XXXX65.1000XXXX44.caXXXXXXXXXXXX

(See Using Authentication Token )

 Request Parameters

ParameterData TypeDescription
typeStringSpecify the value as api. This will return only the modules that are accessible via API.

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="Pulse" sl="Pulse" gt="1">Pulse</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>