getRecordById Method 

  1. Purpose
  2. Request URL
  3. Request Parameters
  4. Job Opening Specific Parameter
  5. Examples
    1. To fetch Candidates without specifying the newFormat parameter
       

Purpose

You can use this method to retrieve individual records by record ID.

Request URL

XML Format: 
https://recruit.zoho.com/recruit/private/xml/Module/getRecordById?authtoken=Auth Token&scope=recruitapi&version=2&id=RecordID

JSON Format:
https://recruit.zoho.com/recruit/private/json/Module/getRecordById?&authtoken=Auth Token&scope=recruitapi&version=2&id=RecordID

Note: Module refers to Candidates, JobOpenings, Clients, Interviews, Contacts, CustomModule1, CustomModule2, CustomModule3, CustomModule4, and CustomModule5.

Request Parameters

ParameterData TypeDescription
authtoken*StringEncrypted alphanumeric string to authenticate your Zoho credentials.
scope*StringSpecify the value as recruitapi
id*String

id: Specify the unique ID of the record.

newFormatInteger (1 or 2)newFormat=1: To exclude fields with "null" values while fetching data from your Recruit account. newFormat=2: To include fields with "null" values while fetching data from your Recruit account.
versionIntegerversion = 2: This will fetch responses based on the latest API implementation.

* - Mandatory parameter

Job Opening Specific Parameter

ParameterData TypeDescription
publishURLBoolean

Set the value as true to get the Job Detail URL and Job Apply URL. By default, this value is false.
 

Note: Job URLs appear only when the job is published in Publish in Website.

 

Examples

To fetch records by ID, use the URL given below:

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecordById?authtoken=Auth Token&scope=recruitapi&version=2&id=ID

To fetch Candidates without specifying the newFormat parameter

Note: When there is no specification of the response format, the default value "1" is assigned to the newFormat parameter, i.e newFormat=1

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecordById?authtoken=Auth Token&scope=recruitapi&id=2000000022020&version=2&selectColumns=Candidates(First Name,Last Name,Email,Current Employer,Source,Phone)

This will return a response like below:

<Candidates>
<row no="1">
<FL val="CANDIDATEID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Candidate Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="No of Employees">10</FL>
<FL val="Annual Revenue">1000.0</FL>
<FL val="SMCREATORID">2000000016908</FL>
<FL val="Created By">John</FL>
<FL val="Created Time">2010-03-16 10:04:52</FL>
<FL val="Modified Time">2010-03-16 10:04:52</FL>
</row>
</Candidates>