getRecords

getRecords

Purpose

You can use the getRecords method to fetch all users data specified in the API request.

Request URL


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
selectColumns
String
Module(optional columns) i.e, Candidates(Last Name,Website,Email) OR All
fromIndex
Integer
Default value - 1
toIndex
Integer
Default value - 20
Maximum value - 200
sortColumnString
String
If you use the sortColumnString parameter, by default, data is sorted in ascending order.
sortOrderString
String
Default value - asc
if you want to sort in descending order, then you have to pass sortOrderString=desc.
lastModifiedTime
DateTime
Default value: null
If you specify the time, modified data will be fetched after the configured time.
newFormat
Integer
newFormat=1: To exclude fields with "null" values while inserting data from your Recruit account.
newFormat=2: To include fields with "null" values while inserting data from your Recruit account.
version
Integer

version=2: This will fetch responses based on the latest API implementation.

version=4: To get multiple records in a single API method call.
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.

Capture Errors

Recruit API provides unique error codes to easily troubleshoot issues in your program while synchronizing data between Recruit and your application. To learn more about various error codes and corresponding definition please refer the Error Codes.

Additional Notes

While retrieving data from your Zoho Recruit, user’s field-level security settings are applied. Hence to fetch all users data, use the user ID with highest role (Ex: Recruiter Admin) and profile (Ex: Administrator).
fromIndex and toIndex are optional parameters. By default, the fromIndex is 1 and toIndex is 20.

sortColumnString and sortOrderString are also optional parameters.

The value for lastModifiedTime parameter should be in yyyy-MM-dd HH:mm:ss format.

Examples

To fetch all accounts in JSON format sorted by Client Name (in descending order) starting from 20 to 200 

URL Format:

https://recruit.zoho.com/recruit/private/json/Clients/getRecords?newFormat=1&authtoken=sbdjEDBDJ445791323
&scope=recruitapi&fromIndex=20&toIndex=200&sortColumnString=Client Name&sortOrderString=desc&version=2

To fetch all accounts in XML format modified / created after 2008-05-27 00:00:00

URL Format:


To fetch candidates with version=2

It will return a response like below:
<Candidates>
<row no="1">
<FL val="CANDIDATEID">292147000000219010</FL>
<FL val="First Name">John</FL>
<FL val="Last Name">Gossling</FL>
<FL val="Email">varunteja.ch+4@zohocorp.com</FL>
<FL val="Phone">1234567890</FL>
<FL val="Source">Varun</FL>
</row>
</Candidates>

To fetch candidates without specifying the newFormat parameter

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

URL Format:


It will return a response like below:
<Candidates>
<row no="1">
<FL val="CANDIDATEID">292147000000107425</FL><FL val="First Name">Edwin</FL><FL val="Last Name">A</FL><FL val="Email">edwinraj.p@gmail.com, edwinirudaya@yahoo.com</FL><FL val="Phone">+919884351702</FL><FL val="City">Pammal</FL><FL val="Current Employer">AVAcorp Technologies Pvt Ltd</FL><FL val="Highest Qualification Held">B.Tech Information Technology</FL><FL val="Source">Imported by parser</FL>
</row>
</Candidates>
 
To fetch with newFormat=2

URL Format:

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi
&newFormat=2&selectColumns=Candidates(Candidate Owner,First Name,Last Name,Company,Designation,Email,Phone,Fax,Mobile,Website,Candidate Source,Candidate Status,No of Employees,Annual Revenue)
This will return a response like below:
<Candidates>
<row no="1">
<FL val="CANDIDATEID">292147000000107430</FL><FL val="First Name">Jobs</FL><FL val="Last Name">Find People</FL><FL val="Email">null</FL><FL val="Phone">null</FL><FL val="City">null</FL><FL val="Current Employer">null</FL><FL val="Highest Qualification Held">null</FL><FL val="Source">Imported by parser</FL>
</row>
</Candidates>
To Call with fromIndex=1, toIndex=25

URL Format:

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(First Name,Last Name,Email,Current Employer,Source,Phone,City,Highest Qualification Held)&version=2&fromIndex=1&toIndex=25

Note: This will return 1 to 25 records.

To Call with lastModifiedTime

URL Format:
https://recruit.zoho.com/recruit/private/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(First Name,Last Name,Email,Current Employer,Source,Phone,City,Highest Qualification Held)lastModifiedTime=2010-04-21 11:09:23&version=2

Note: If you specify the time, modified data will be fetched after the configured time.

To select all fields from candidates with newFormat=1

Note: This will return all fields which have values.

To select all fields from candidates with newFormat=2

Note: This will return all fields, including null value fields.

To Call with lastModifiedTime, fromIndex and toIndex

URL Format:

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(First Name,Last Name,Email,Current Employer,Source,Phone,City,Highest Qualification Held)&lastModifiedTime=2010-04-21 11:09:23&fromIndex=1&toIndex=25&version=2 

    • 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 ...

    • Responses & Exceptions - C# SDK

      APIResponse, BulkAPIResponse and FileAPIResponse are the wrapper objects for Zoho CRM APIs’ responses. All API calling methods would return one of these two objects. A method-seeking entity would return  APIResponse  object, whereas a method-seeking ...

    • Using Authentication Token

      The Zoho Recruit API is available in all editions of Zoho Recruit. To use the API, you'll require the Zoho Recruit Authentication Token from your Recruit account. Please make sure that you have the permission to access the API service. If you do not ...

    • Uploading Documents, Creating Files, and Other Functions

      Upload Documents In the Documents tab you can upload presentations, spreadsheets, PDFs, and the like for easy access. You can upload up to 10 files at a time. Availability Permission Required Users with view, create, modify, and delete document ...

    • Uploading Documents, Creating Files, and Other Functions

      Upload Documents In the Documents tab you can upload presentations, spreadsheets, PDFs, and the like for easy access. You can upload up to 10 files at a time. Availability Permission Required Users with view, create, modify, and delete document ...