getRecordById
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=AuthToken&scope=recruitapi&version=2&id=RecordID
JSON Format:
https://recruit.zoho.com/recruit/private/json/Module/getRecordById?&authtoken=AuthToken&scope=recruitapi&version=2&id=RecordID
Note: Module refers to Candidates, JobOpenings, Clients, Interviews, Contacts, CustomModule1, CustomModule2, CustomModule3, CustomModule4, and CustomModule5.
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 |
| 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 |
| id* |
String |
id: Specify the unique ID of the record. |
| newFormat |
Integer (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. |
| version |
Integer |
version = 2: This will fetch responses based on the latest API implementation. |
Note:
Parameters marked with * are mandatory.
Job Opening Specific Parameter
| Parameter |
Data Type |
Description |
| publishURL |
Boolean |
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,
URL Format:
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
URL Format:
https://recruit.zoho.com/recruit/private/xml/Candidates/getRecordByIdauthtoken=AuthToken&scope=recruitapi&id=2000000022020&version=2&selectColumns=Candidates(FirstName,LastName,Email,Current Employer,Source,Phone)
Sample Response:
<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>
<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>