Zoho Recruit | getRecordById Method

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>

    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


          Get started with Zoho Sign

          in a few quick steps!

          Download Help Guide





                    Still can't find what you're looking for?

                    Write to us: support@zohoforms.com


                          



                          





                        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 SalesIQ Resources



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