getSearchRecords
Purpose
You can use this method to search records by the expressions of the selected columns.
Request URL
XML Format:
https://recruit.zoho.com/recruit/private/xml/Module/getSearchRecords?authtoken=AuthToken&scope=recruitapi
JSON Format:
https://recruit.zoho.com/recruit/private/json/Module/getSearchRecords?authtoken=AuthToken&scope=recruitapi
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 |
|
referral, campaign, assessment, vendor, offer,
attachment,
forecast, note, call, event, task, 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
| 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 |
| searchCondition* |
XML |
(Created By|=|username) |
| newFormat |
Integer (1 or 2) |
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. |
| fromIndex |
Integer |
Default value - 1 |
| toIndex |
Integer |
Default value - 20 Maximum value - 200 |
| 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. |
Regular Expressions
While using this method, ensure selectColumns and searchCondition parameters are set as mandatory. You can specify the following expressions in API request:
- is OR =
- isn't OR <>
- contains(*srcString*)
- starts with(srcString*)
- ends with(*srcString)
- doesn't contain
- < OR is before
- > OR is after
- <=
- =>
Examples
Example #1
If you want to select Last Name, Current Employer, Email, Mobile from Candidates and Email should contain "@sample.com", Search API request should be as given below:
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Current Employer,Email,Mobile)&searchCondition=(Email|contains|*@sample.com*)
Example #2
If you want to select Last Name, Email, Website, Experience in Years from Candidates and Experience in Years should be greater than 2, Search API request should be as given below:
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Website,Experience in Years)&searchCondition=(Experience in Years|>|2)
Example #3
If you want to select Last Name, Email from Candidates and Company should start with "Zoho", then the search API request should be as given below:
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email)&searchCondition=(Current Employer|starts with|Zoho*)
Example with equal(=)
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(First Name,Last Name,Email)&searchCondition=(Email|=|test@test.com)
Example with less than(<)
Note: Replace null value Integer fields with "0". Integer fields with no value will not be included in the search.
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Current Employer)&searchCondition=(customfield1|<|1000)
Example with contains
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Current Employer)&searchCondition=(Current Employer|contains|*oho*)
Example with starts with
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Current Employer)&searchCondition=(Current Employer|starts with|zoho*)
Example with ends with
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Current Employer)
&searchCondition=(Current Employer|ends with|*zoho)
&searchCondition=(Current Employer|ends with|*zoho)