getModules
Purpose
You can use the getModules method to get the list of modules in your Recruit account.
Request URL
XML Format:
JSON Format:
For OAuth Authentication
| Header Name | Value |
| Authorization | Zoho-oauthtoken {access_token} |
Scopes
Scope=ZohoRecruit.modules.all
(or)
Scope=ZohoRecruit.modules.{scope_name}.{operation_type}
| Possible Scope Names (Case Sensitive) | Operation Types |
referral, campaign, assessment, vendor, offer, attachment, forecast, note, call, event, task, candidate, jobopening, client, department, interview, contact & custom (for all Custom Modules) | ALL - Full access to the record READ - Get records from the module |
For Authtoken Authentication
| Parameter | Data Type | Description |
| authtoken* | String | Encrypted alphanumeric string to authenticate your Zoho credentials. |
| scope* | String | Specify the value as recruitapi |
Request Parameters
| Parameter | Data Type | Description |
| authtoken* | String | Encrypted alphanumeric string to authenticate your Zoho credentials. |
| scope* | String | Specify the value as recruitapi. |
| version* | Integer | Use version=2: This will fetch responses based on the latest API implementation. |
Note: Parameters marked with * are mandatory.
Sample Response
Code Snippet:
<response uri="/recruit/internal/xml/Info/getModules">
<result>
<row no="1" id="xxxx000000002xxx" pl="Job Openings" sl="Job Opening" gt="1">Job Openings</row>
<row no="2" id="xxxx000000002xxx" pl="Candidates" sl="Candidate" gt="1">Candidates</row>
<row no="3" id="xxxx000000002xxx" pl="Interviews" sl="Interview" gt="1">Interviews</row>
<row no="4" id="xxxx000000002xxx" pl="Clients" sl="Client" gt="1">Clients</row>
<row no="5" id="xxxx000000002xxx" pl="Contacts" sl="Contact" gt="1">Contacts</row>
<row no="6" id="xxxx000000002xxx" pl="ToDo's" sl="ToDo" gt="1">ToDo's</row>
<row no="7" id="xxxx000000002xxx" pl="Emails" sl="Email" gt="1">Emails</row>
<row no="8" id="xxxx000000002xxx" pl="Documents" sl="Documents" gt="1">Documents</row>
<row no="9" id="xxxx000000002xxx" pl="Social" sl="Social" gt="1">Social</row>
</result>
</response>
Related Articles
API Methods
Method Name Purpose getRecords To retrieve all users data specified in the API request getRecordById To retrieve individual records by record ID addRecords To insert records into the required Zoho Recruit module updateRecords To update or modify the ...Class Hierarchy - Node JS SDK
All Zoho CRM entities are modelled as modules having classes, methods and instance variables applicable to that particular entity. ZCRMRestClient is the base class of the Python SDK. ZCRMRestClient has methods to get instances of various other Zoho ...Sample Codes - Node JS SDK
All of Zoho CRM's APIs can be used through the Node JS SDK, to enable your custom application to perform data sync to the best degree. Here are the sample codes for all the API methods available in our SDK. Organization & User Operations These ...