Zoho Recruit | getRecords Method

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:

https://recruit.zoho.com/recruit/private/xml/Clients/getRecords?newFormat=1&authtoken=sbdjEDBDJ1323
&scope=recruitapi&lastModifiedTime=2008-05-27 00:00:00&version=2

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">johngosling@zmail.com</FL>
<FL val="Phone">1234567890</FL>
<FL val="Source">Added by User</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:

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
It will return a response like below:
<Candidates>
<row no="1">
<FL val="CANDIDATEID">292147000000107425</FL><FL val="First Name">John</FL><FL val="Last Name">Doe</FL><FL val="Email">jogndoe@zmail.com</FL><FL val="Phone">555-555-5555</FL><FL val="City">Austin</FL><FL val="Current Employer">Avon Corp Inc</FL><FL val="Highest Qualification Held">Bachelor of Sciences - Biology</FL><FL val="Source">Added by User</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 

    Access your files securely from anywhere

      Zoho CRM Training Programs

      Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

      Zoho CRM Training
        Redefine the way you work
        with Zoho Workplace

          Zoho DataPrep Personalized Demo

          If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

          Zoho CRM Training

            Create, share, and deliver

            beautiful slides from anywhere.

            Get Started Now


              Zoho Sign now offers specialized one-on-one training for both administrators and developers.

              BOOK A SESSION





                          Quick Links Workflow Automation Data Collection
                          Web Forms Enterprise Begin Data Collection
                          Interactive Forms Workplace Data Collection App
                          CRM Forms Customer Service Accessible Forms
                          Digital Forms Marketing Forms for Small Business
                          HTML Forms Education Forms for Enterprise
                          Contact Forms E-commerce Forms for any business
                          Lead Generation Forms Healthcare Forms for Startups
                          Wordpress Forms Customer onboarding Order Forms for Small Business
                          No Code Forms Construction RSVP tool for holidays
                          Free Forms Travel
                          Prefill Forms Non-Profit

                          Intake Forms Legal
                          Mobile App
                          Form Designer HR
                          Mobile Forms
                          Card Forms Food Offline Forms
                          Assign Forms Photography
                          Mobile Forms Features
                          Translate Forms Real Estate Kiosk in Mobile Forms
                          Electronic Forms

                          Notification Emails for Forms Alternatives Security & Compliance
                          Holiday Forms Google Forms alternative  GDPR
                          Form to PDF Jotform alternative HIPAA Forms
                          Email Forms
                          Encrypted Forms
                          Embeddable Forms
                          Secure Forms
                          Drag and Drop form builder
                          WCAG


                                            You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                Manage your brands on social media

                                                  Zoho Desk Resources

                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                    Zoho Marketing Automation

                                                      Zoho Sheet Resources

                                                       

                                                          Zoho Forms Resources


                                                            Secure your business
                                                            communication with Zoho Mail


                                                            Mail on the move with
                                                            Zoho Mail mobile application

                                                              Stay on top of your schedule
                                                              at all times


                                                              Carry your calendar with you
                                                              Anytime, anywhere




                                                                    Zoho Sign Resources

                                                                      Sign, Paperless!

                                                                      Sign and send business documents on the go!

                                                                      Get Started Now




                                                                              Zoho TeamInbox Resources



                                                                                      Zoho DataPrep Resources



                                                                                        Zoho DataPrep Demo

                                                                                        Get a personalized demo or POC

                                                                                        REGISTER NOW


                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now









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

                                                                                                                Purpose You can use the addRecords method to insert records into the required Zoho Recruit module. Note: Use the POST method to pass these parameters instead of the GET method. Request URL XML Format: ...
                                                                                                                Wherever you are is as good as
                                                                                                                your workplace

                                                                                                                  Resources

                                                                                                                  Videos

                                                                                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                  eBooks

                                                                                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                  Webinars

                                                                                                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                  CRM Tips

                                                                                                                  Make the most of Zoho CRM with these useful tips.



                                                                                                                    Zoho Show Resources