Get Associated Records
To get a list of associated records for a specific record id via API.
Eg: Associated Job Openings for a Candidate or associated Candidates for a Job Opening.
Purpose
To get the list of available records from a module.
Request URL
https://recruit.zoho.com/recruit/v2/{module_api_name}/{record_id}/associate
module_api_name - The API name of the module
record_id - The unique Id of the record
Request Method
GET
Scope
scope=ZohoRECRUIT.modules.all
(or)
scope=ZohoRECRUIT.modules.{module_name}.{operation_type}
| Possible module names | Possible operation types |
|---|---|
| candidate and jobopening | ALL - Full access to the record READ - Get records from the module |
Parameters
| Parameter Name | Data Type | Description | Possible Values |
|---|---|---|---|
| posting_title (optional) | String | To get a list of associated job openings for a candidate where the job openings have this posting title | Marketing Executive, Java Developer, etc. |
| candidate_statuses (optional) | String | To get a list of associated candidates for a job opening where the candidates have this status | Associated, Contacted, etc. |
| page (optional) | Integer | To get the list of records from the respective pages. The default value for the page is 1. | Positive Integer values only |
| per_page (optional) | Integer | To get the list of records available per page. The default value for the page is 200. | Positive Integer values only |
Sample Response - Get Associated Job Openings
Copied{
"data": [
{
"Email": null,
"$currency_symbol": "$",
"Last_Activity_Time": "2019-12-18T11:01:15+05:30",
"GDPR_Consent_Date": "2019-12-18",
"Highest_Qualification_Held": null,
"Skill_Set": null,
"$converted": false,
"$process_flow": false,
"Updated_On": "2019-12-18T10:58:04+05:30",
"Current_Employer": null,
"Street": null,
"Zip_Code": null,
"id": "100001000000028010",
"Experience_in_Years": null,
"$approved": true,
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"GDPR_Consent_Status": "Opt-In not requested",
"Candidate_Status": "Unqualified",
"Candidate_ID": "ZR_3_CAND",
"Last_Mailed_Time": null,
"Created_Time": "2019-12-18T10:58:04+05:30",
"$followed": false,
"GDPR_Consent_Mode": null,
"$editable": true,
"Is_Locked": false,
"City": null,
"Candidate_Owner": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"Is_Unqualified": false,
"Associated_Tags": [],
"Additional_Info": null,
"State": null,
"Country": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"Is_Attachment_Present": false,
"CANDIDATEPORTALSTATUS": "0",
"Rating": null,
"Website": null,
"Twitter": null,
"Current_Job_Title": null,
"Salutation": null,
"Source": "Added by User",
"First_Name": null,
"Full_Name": "av",
"Modified_By": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"Skype_ID": null,
"Experience_Details": [],
"Phone": null,
"Email_Opt_Out": false,
"Educational_Details": [],
"$converted_detail": {},
"Mobile": null,
"Last_Name": "av",
"Current_Salary": null,
"Associated_any_Social_Profiles": null,
"Fax": null,
"Expected_Salary": null
},
{
"Email": null,
"$currency_symbol": "$",
"Last_Activity_Time": "2019-12-18T11:00:01+05:30",
"GDPR_Consent_Date": "2019-12-18",
"Highest_Qualification_Held": null,
"Skill_Set": null,
"$converted": false,
"$process_flow": false,
"Updated_On": "2019-12-18T10:55:54+05:30",
"Current_Employer": null,
"Street": null,
"Zip_Code": null,
"id": "100001000000028001",
"Experience_in_Years": null,
"$approved": true,
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"GDPR_Consent_Status": "Opt-In not requested",
"Candidate_Status": "Qualified1",
"Candidate_ID": "ZR_2_CAND",
"Last_Mailed_Time": null,
"Created_Time": "2019-12-18T10:55:54+05:30",
"$followed": false,
"GDPR_Consent_Mode": null,
"$editable": true,
"Is_Locked": false,
"City": null,
"Candidate_Owner": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"Is_Unqualified": false,
"Associated_Tags": [],
"Additional_Info": null,
"State": null,
"Country": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"Is_Attachment_Present": false,
"CANDIDATEPORTALSTATUS": "0",
"Rating": null,
"Website": null,
"Twitter": null,
"Current_Job_Title": null,
"Salutation": null,
"Source": "Added by User",
"First_Name": null,
"Full_Name": "a",
"Modified_By": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"Skype_ID": null,
"Experience_Details": [],
"Phone": null,
"Email_Opt_Out": false,
"Educational_Details": [],
"$converted_detail": {},
"Mobile": null,
"Last_Name": "a",
"Current_Salary": null,
"Associated_any_Social_Profiles": null,
"Fax": null,
"Expected_Salary": null
},
{
"Email": null,
"$currency_symbol": "$",
"Last_Activity_Time": "2019-12-12T12:39:52+05:30",
"GDPR_Consent_Date": "2019-12-04",
"Highest_Qualification_Held": null,
"Skill_Set": null,
"$converted": false,
"$process_flow": false,
"Updated_On": "2019-12-04T16:16:26+05:30",
"Current_Employer": null,
"Street": null,
"Zip_Code": null,
"id": "100001000000022003",
"Experience_in_Years": null,
"$approved": true,
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"GDPR_Consent_Status": "Opt-In not requested",
"Candidate_Status": "Associated",
"Candidate_ID": "ZR_1_CAND",
"Last_Mailed_Time": null,
"Created_Time": "2019-12-04T16:16:26+05:30",
"$followed": false,
"GDPR_Consent_Mode": null,
"$editable": true,
"Is_Locked": false,
"City": null,
"Candidate_Owner": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"Is_Unqualified": false,
"Associated_Tags": [],
"Additional_Info": null,
"State": null,
"Country": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"Is_Attachment_Present": false,
"CANDIDATEPORTALSTATUS": "0",
"Rating": null,
"Website": null,
"Twitter": null,
"Current_Job_Title": null,
"Salutation": null,
"Source": "Added by User",
"First_Name": null,
"Full_Name": "a",
"Modified_By": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"Skype_ID": null,
"Experience_Details": [],
"Phone": null,
"Email_Opt_Out": false,
"Educational_Details": [],
"$converted_detail": {},
"Mobile": null,
"Last_Name": "a",
"Current_Salary": null,
"Associated_any_Social_Profiles": null,
"Fax": null,
"Expected_Salary": null
}
],
,
"info": {
"per_page": 200,
"count": 3,
"page": 1,
"more_records": false
}
}Sample Response - Get Associated Job Openings
Copied{
"data": [
{
"Salary": null,
"$currency_symbol": "$",
"Account_Manager": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"No_of_Candidates_Hired": 0,
"Target_Date": "2019-12-31",
"Last_Activity_Time": "2019-12-12T12:38:44+05:30",
"Industry": "Marketing",
"Modified_By": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"$process_flow": false,
"Expected_Revenue": null,
"Is_Hot_Job_Opening": false,
"Account_Name": {
"name": "My company",
"id": "100001000000020446"
},
"Zip_Code": null,
"id": "100001000000025064",
"Skillset": "Marketing",
"$approved": true,
"Publish": false,
"Date_Opened": "2019-12-12",
"Potential_Name": "Marketing Executive",
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2019-12-12T12:38:44+05:30",
"Actual_Revenue": null,
"Created_Time": "2019-12-12T12:38:44+05:30",
"$followed": false,
"No_of_Candidates_Associated": 1,
"$editable": true,
"Is_Locked": false,
"City": null,
"Job_Opening_Status": "In-progress",
"Revenue_per_Position": 0,
"Contact_Name": null,
"Associated_Tags": [],
"Assigned_Recruiter": [],
"Missed_Revenue": null,
"Job_Opening_ID": "ZR_2_JOB",
"Job_Description": "<span id=\"spandesc\"><p class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"font-weight: bold\"> <font size=\"3\">Summary</font></span></p><p class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <font size=\"3\"> <span style=\"\">Weâ??re looking for a talented Marketing Executive who can undertake marketing projects for the benefit of our company. The candidate must be able to </span> <span style=\"\">organize creative campaigns and promotional events that add to our companyâ??s brand value. Ideally, the </span> <span style=\"\">candidate must have passion for the â??artâ?? of marketing, have an abundance of ideas for building efficient strategies and must bring forth a strong arsenal of techniques/methods to promote our products, services and public image. </span> <span style=\"\">The goal is to reach out to the market and cultivate the customerâ??s interest in our products and services in ways that strengthen our reputation and facilitate our exponential growth.</span></font></p><p class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <font size=\"3\"> <span class=\"EOP\"></span> <span style=\"font-weight: bold\">Responsibilities</span></font></p><ul style=\"\"> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Conceive and develop efficient and intuitive marketing strategies.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Organize and oversee advertising/communication campaigns (social media, TV etc. ), exhibitions and promotional events.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Conduct market research and analysis to evaluate trends, brand awareness and competition ventures.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Initiate and control surveys to assess customer requirements and dedication.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Write copy for diverse marketing distributions (brochures, press releases, website material etc. ).</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Maintain relationships with media vendors and publishers to ensure collaboration in promotional activities.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Monitor progress of campaigns using various metrics and submit reports of performance.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <font size=\"3\">Collaborate with managers in preparing budgets and monitoring expenses.</font></li></ul></span><br /><span id=\"spanreq\"><h3>Requirements</h3><p class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"font-weight: bold\"> <font size=\"3\">Requirements</font></span></p><ul style=\"\"> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Proven experience as a marketing executive or any other similar role.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Good understanding of market research techniques, data analysis and statistics methods.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Thorough knowledge of strategic planning principles and marketing best practices.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Proficient in MS Office and marketing software (e.g. CRM).</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Familiarity with social media and web analytics (e.g. WebTrends).</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Excellent communication and people skills.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Strong organizational and time-management abilities.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\"> <font size=\"3\">Creativity and commercial awareness.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <font size=\"3\">B.Sc/BA in marketing, business administration or any other relevant disciplines.</font></li></ul></span><br />",
"Work_Experience": null,
"Job_Type": "Full time",
"State": null,
"Number_of_Positions": "1",
"Country": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"Is_Attachment_Present": false
},
{
"Salary": null,
"$currency_symbol": "$",
"Account_Manager": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"No_of_Candidates_Hired": 0,
"Target_Date": "2019-12-13",
"Last_Activity_Time": "2019-12-12T12:33:02+05:30",
"Industry": "Accounting",
"Modified_By": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"$process_flow": false,
"Expected_Revenue": null,
"Is_Hot_Job_Opening": false,
"Account_Name": {
"name": "My company",
"id": "100001000000020446"
},
"Zip_Code": null,
"id": "100001000000025001",
"Skillset": "Accounting",
"$approved": true,
"Publish": false,
"Date_Opened": "2019-12-12",
"Potential_Name": "Accountant",
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2019-12-12T12:33:02+05:30",
"Actual_Revenue": null,
"Created_Time": "2019-12-12T12:33:02+05:30",
"$followed": false,
"No_of_Candidates_Associated": 3,
"$editable": true,
"Is_Locked": false,
"City": null,
"Job_Opening_Status": "In-progress",
"Revenue_per_Position": 0,
"Contact_Name": null,
"Associated_Tags": [],
"Assigned_Recruiter": [],
"Missed_Revenue": null,
"Job_Opening_ID": "ZR_1_JOB",
"Job_Description": "<span id=\"spandesc\"><p class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"font-weight: bold\"> <font size=\"3\">Summary</font></span></p><p class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"color: rgb(51, 51, 51)\"> <font size=\"3\">Weâ??re looking to hire an Account Coordinator who can provide day-to-day administrative support to our Account Executives and Account Representatives and ensure smooth sales procedures. Candidates applying for the role should be highly organized and able to perform multiple tasks for different teams/clients at the same time. Any sort of experience with marketing campaigns and an understanding of what â??excellent customer serviceâ?? means is valued highly. Ideally, the candidate should be able to both administer daily sales activities and brainstorm innovative ideas to improve our client relationships. The Candidate should drive growth to our company by being an essential part of the Account Management team.</font></span></p><div> <span style=\"font-weight: bold; color: rgb(51, 51, 51)\"> <font size=\"3\">Responsibilities</font></span></div><div> <span style=\"color: rgb(51, 51, 51)\"> <ul style=\"\"> <font size=\"3\"> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\">Prepare, file and</span> <span style=\"\">retrieve</span> <span style=\"\"> sales-related documents.</span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\">Design and renew sales proposals.</span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\">Update internal databases with account information.</span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\">Coordinate meetings, calls and demos for the Account Management team.</span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\">Conduct research on prospective clients.</span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\">Collaborate with internal teams to ensure proper pre-and post-sales service.</span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\">Communicate customer feedback to Marketing, Sales and Product Development teams.</span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\">Create detailed reports of campaign results.</span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"\">Perform</span> <span style=\"\"> market and competitive research.</span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\">Help create promotional materials (e.g.<span style=\"\">presentations</span> <span style=\"\"> and videos).</span></li></font></ul></span></div></span><br /><span id=\"spanreq\"><h3>Requirements</h3><p class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"font-weight: bold\"> <font size=\"3\">Requirements:</font></span></p><ul style=\"\"> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"color: rgb(51, 51, 51)\"> <font size=\"3\">Proven work experience as an Account Coordinator, Sales Coordinator or any other similar role.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"color: rgb(51, 51, 51)\"> <font size=\"3\">Excellent computer skills (MS Office in particular).</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"color: rgb(51, 51, 51)\"> <font size=\"3\">Hands-on experience with any CRM software.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"color: rgb(51, 51, 51)\"> <font size=\"3\">Experience with marketing/advertising campaigns.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"color: rgb(51, 51, 51)\"> <font size=\"3\">Organizational and time-management skills.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <span style=\"color: rgb(51, 51, 51)\"> <font size=\"3\">Strong communication skills with a problem-solving attitude.</font></span></li> <li class=\"zw-paragraph heading0\" style=\"border-width: 0px; border-style: none; border-color: rgb(0, 0, 0); line-height: 1.2\"> <font size=\"3\">B.Sc in Business Administration, Marketing or any other relevant field.</font></li></ul></span><br />",
"Work_Experience": null,
"Job_Type": "Full time",
"State": null,
"Number_of_Positions": "1",
"Country": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "100001000000020223"
},
"Is_Attachment_Present": false
}
],
,
"info": {
"per_page": 200,
"count": 2,
"page": 1,
"more_records": false
}
}