Search Records
Purpose
To retrieve the records that match your search criteria.
Request URL
https://recruit.zoho.com/recruit/v2/{module_api_name}/search
module_api_name - The API name of the module
| Supported modules |
|---|
| Candidates, Applications, Job Openings, Interviews, Clients, Contacts, Departments, Tasks, Events, Vendors, Campaigns, and all Custom Modules​ |
Request Method
GET
Scope
scope=ZohoRecruit.modules.all
(or)
scope=ZohoRecruit.modules.{module_name}.{operation_type}
(and)
scope=ZohoSearch.securesearch.READ
| Possible module names | Possible operation types |
|---|---|
candidate, jobopening, client, interview, contact, and custommodule | ALL - Full access to the record READ - Get records from the module |
Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| criteria | String |
|
| String | Performs module search by email. All the email fields of a particular module will be searched and listed. | |
| phone | String | Performs module search by phone number. All the phone fields of a particular module will be searched and listed. |
| word | String | Performs global search by word. |
| converted (optional) | String | To get the list of converted records. The default value is false. true - get only converted records false - get only non-converted records both - get all records |
| approved (optional) | String | To get the list of approved records. The default value is true. true - get only approved records false - get only records that are not approved both - get all records |
| page (optional) | Integer | To get the list of records from the respective pages. The default value for the page is 1. |
| per_page (optional) | Integer | To get the list of records available per page. The default value for the page is 200. |
Note:
Only one of the above four parameters would work at one point in time. Furthermore, if two parameters are given simultaneously, preference will be given in the order criteria, email, phone, and word, and only one of them would work.
The page and per_page parameter is used to fetch records according to their position in Recruit. Let's assume that the user has to fetch 400 records. The maximum number of records that one can get for an API call is 200. So, for records above the 200th position, they cannot be fetched. By changing the values of the page (1, 2) and per_page (200) parameters, the user can fetch all 400 records using 2 API calls.
Sample Request: To Search by Criteria
Copiedcurl "https://recruit.zoho.com/recruit/v2/Candidates/search?criteria=(Last_Name:contains:Jacky)"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Sample Response
Copied{
"data": [
{
"Origin": null,
"Email": "samuel@zoho.com",
"$currency_symbol": "Rs.",
"Last_Activity_Time": "2020-08-21T17:03:13+05:30",
"Highest_Qualification_Held": null,
"Skill_Set": null,
"$converted": false,
"$process_flow": false,
"Brother": null,
"Updated_On": "2020-08-21T17:03:13+05:30",
"Current_Employer": null,
"Street": null,
"Zip_Code": null,
"id": "486812000001660091",
"Experience_in_Years": null,
"$approved": true,
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Candidate_Status": "New",
"Candidate_ID": "ZR_446_CAND",
"Last_Mailed_Time": null,
"Created_Time": "2020-08-21T16:10:59+05:30",
"$followed": false,
"$editable": true,
"Is_Locked": false,
"City": "Chennai",
"Lead_Owner": {
"name": "Thomas Shelby",
"id": "486812000000216003"
},
"Is_Unqualified": false,
"Associated_Tags": [],
"Additional_Info": null,
"State": null,
"Country": null,
"Created_By": {
"name": "Thomas Shelby",
"id": "486812000000216003"
},
"Secondary_Email": null,
"Is_Attachment_Present": false,
"Salary": 0,
"Rating": null,
"Website": null,
"Twitter": null,
"Current_Job_Title": null,
"Salutation": null,
"Source": "Added by User",
"First_Name": "Samuel",
"Full_Name": "Samuel Jacky",
"Modified_By": {
"name": "Thomas Shelby",
"id": "486812000000216003"
},
"Skype_ID": null,
"Experience_Details": [],
"Phone": null,
"Email_Opt_Out": false,
"JobOpening1": null,
"Educational_Details": [],
"$converted_detail": {},
"Career_Page_Invite_Status": "0",
"Mobile": "7685635434456",
"Last_Name": "Jacky",
"Current_Salary": 0,
"Possible_Salary": 0,
"Associated_any_Social_Profiles": null,
"Fax": null,
"Expected_Salary": 0
},
{
"Origin": null,
"Email": "newlead@zoho.com",
"$currency_symbol": "Rs.",
"Last_Activity_Time": "2020-08-21T16:08:26+05:30",
"Highest_Qualification_Held": null,
"Skill_Set": null,
"$converted": false,
"$process_flow": false,
"Brother": null,
"Updated_On": "2020-08-21T16:08:26+05:30",
"Current_Employer": null,
"Street": null,
"Zip_Code": null,
"id": "486812000001660077",
"Experience_in_Years": null,
"$approved": true,
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Candidate_Status": "New",
"Candidate_ID": "ZR_443_CAND",
"Last_Mailed_Time": null,
"Created_Time": "2020-08-21T16:08:26+05:30",
"$followed": false,
"$editable": true,
"Is_Locked": false,
"City": null,
"Lead_Owner": {
"name": "Thomas Shelby",
"id": "486812000000216003"
},
"Is_Unqualified": false,
"Associated_Tags": [],
"Additional_Info": null,
"State": null,
"Country": null,
"Created_By": {
"name": "Thomas Shelby",
"id": "486812000000216003"
},
"Secondary_Email": null,
"Is_Attachment_Present": false,
"Salary": null,
"Rating": null,
"Website": null,
"Twitter": null,
"Current_Job_Title": null,
"Salutation": null,
"Source": "Added by User",
"First_Name": "Sagar",
"Full_Name": "Sagar Alias Jacky",
"Modified_By": {
"name": "Thomas Shelby",
"id": "486812000000216003"
},
"Skype_ID": null,
"Experience_Details": [],
"Phone": null,
"Email_Opt_Out": false,
"JobOpening1": null,
"Educational_Details": [],
"$converted_detail": {},
"Career_Page_Invite_Status": "0",
"Mobile": "7685635434456",
"Last_Name": "Alias Jacky",
"Current_Salary": null,
"Possible_Salary": null,
"Associated_any_Social_Profiles": null,
"Fax": null,
"Expected_Salary": null
}
],
"info": {
"per_page": 200,
"count": 2,
"page": 1,
"more_records": false
}
}