Get record by ID from Zoho Recruit 

Table of Contents

Note:

  • Each time the zoho.recruit.getRecordbyId integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
  • Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.recruit.getRecordbyId integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script. 

Overview

The zoho.recruit.getRecordbyId task is used to fetch records from Zoho Recruit, based on the specified record ID. This integration task is based on the Zoho Recruit - Get Record By ID API.

Syntax

<variable> = zoho.recruit.getRecordbyId(<module_name>, <recordID>, <connection>);

where:

ParameterData typeDescription
<variable> KEY-VALUE Response returned by Zoho Recruit.
<module_name>TEXT 

Zoho Recruit module from which the record will be fetched.

Applicable modules:

  • Candidates
  • Job Openings
  • Contacts
  • Clients
  • Interviews
  • Custom Module
<recordID>NUMBER 

ID of the record that will be fetched.

Learn how to fetch the ID of a record after creating, searching or fetching it.

<connection>TEXT

The link name of the Zoho Recruit connection.

Note:

  • In view of stopping new authtoken generation, a Zoho OAuth connection with appropriate scopes is mandatory in order for new integration tasks (created after the deadline specified in the post) to work as expected. Existing integration tasks will continue to work with or without the connections parameter until you manually delete the authtoken from accounts.
  • Add relevant scopes mentioned in Zoho Recruit - Get Record By ID API while creating the connection.
  • Refer to this post for the list of Zoho services that support the connections page.
  • Learn more about connections

Fetch record from Candidates module

The following script fetches the record with ID - 1687000000106001 from the "Candidates" module in Zoho Recruit.

response= zoho.recruit.getRecordById("Candidates" ,1687000000106001, "recruit_connection");

where:

"Candidates"
is a TEXT that represents the module in which the record will be created.
1687000000106001
is a NUMBER that represents the ID of the record that will be fetched.
"recruit_connection"
is a TEXT that represents the connection link name.

Sample Response

The following is a sample success response:

{  
   "Is Locked":"false",
   "Candidate ID":"ZR_26_CAND",
   "CANDIDATEID":"1687000000106001",
   "Is Unqualified":"false",
   "Updated On":"2015-11-19 18:09:28",
   "Created By":"dinesh.d",
   "Is Attachment Present":"true",
   "Source":"Added by User",
   "MODIFIEDBY":"1687000000077003",
   "Created Time":"2015-09-16 16:29:33",
   "Modified By":"dinesh.d",
   "SMOWNERID":"1687000000077003",
   "Candidate Status":"New",
   "Last Activity Time":"2015-11-19 18:09:28",
   "SMCREATORID":"1687000000077003",
   "Email Opt Out":"false",
   "Is Hot Candidate":"false",
   "Last Name":"Tom & Jerry",
   "Candidate Owner":"john"
}

Related Links