getRecordById

getRecordById

Purpose

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

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

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

    • Related Articles

    • How do I retrieve a single Account using getAllRecords?

      You can retrieve a single account using the getRecordById method by passing the ID of the record.

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

    • Assess the outgoing call quality of the sales agents

      Industry: Insurance | Feature: Workflow Rule | Integration: Zoho Survey and Telephony | Edition: Enterprise Scenario  Maria, a sales manager at an insurance company, heads a team of five sales agents. The team offers assistance via phone to ...

    • Integration Tasks - Python

      As you might already know, the update to Version 2.0 APIs played a major part in using custom functions, now named "Functions". This guide will help you how to use functions integration tasks which uses the new APIs. Getting Started For starters, the ...

    • Functions - Integration Tasks

      As you might already know, the update to Version 2.0 APIs played a major part in using custom functions, now named "Functions". This guide will help you how to use functions integration tasks which uses the new APIs. Getting Started For starters, the ...