Modules and Fields

Note: If you’re using the new version of APIs (V2), refer this link.

You can use API to integrate with the following standard modules:

Standard Module	API Format
Candidates	Candidates
Clients	Clients
Contacts	Contacts
Job Openings	JobOpenings
Tasks	Tasks
Events	Events
Calls	Calls
Interviews	Interviews

Note:

API support is not available for the Forecasts module.
You must use the API format given the above table. If you use "candidates" for "Candidates" module or "job openings" for "Job Openings", API will return Unable to process your request error message.
Fields marked with an asterix (*) are mandatory.

The following tables give the list of supported fields in the Zoho Recruit Modules along with their description.

Candidates

Field Name	API Format	Description	Data type	Maximum Limit
Candidate Owner	Candidate Owner	Select the Zoho Recruit user to whom the Candidate is assigned.	Lookup	-
Salutation	Salutation	Select the salutation from the drop-down list.	Pick list	-
First Name	First Name	Specify the first name of the candidate.	Text box	Alphanumeric(40)
Candidate ID	Candidate ID	Specify the ID of the candidate.	Auto number	Alphanumeric(120)
Last Name*	Last Name*	Specify the last name of the candidate. This field is a mandatory.	Text box	Alphanumeric(80)
Experience in Years	Experience in Years	Specify the working experience in years of the candidate.	Double	-
Source	Source	Select the source of the candidate i.e. from where the candidate is generated.	Pick list	-
Highest Qualification Held	Highest Qualification Held	Select the highest qualification held by the candidate.	Pick list	-
Current Job Title	Current Job Title	Specify the current job title of the candidate	Pick list	-
Phone	Phone	Specify the phone number of the candidate.	Text box	Alphanumeric(30)
Mobile	Mobile	Specify the mobile number of the candidate.	Text box	Alphanumeric(30)
Fax	Fax	Specify the fax number of the candidate.	Text box	Alphanumeric(30)
Email	Email	Specify the email address of the candidate.	Email	Alphanumeric and Special characters(100)
Current Employer	Current Employer	Specify the current employer of the candidate.	Text box	Alphanumeric(100)
Skype ID	Skype ID	Specify the Skype ID of the candidate. Currently, Skype ID can be in the range of 6 to 32 characters.	Text box	Alphanumeric(50)
Website	Website	Specify the website of the candidate.	URL	Alphanumeric(120)
Candidate Status	Candidate Status	Select the status of the candidate from the drop-down list.	Pick list	-
Expected Salary	Expected Salary	Select the expected salary of the candidate.	Currency	Decimal(16)
Current Salary	Current Salary	Select the current salary of the candidate.	Currency	Decimal(16)
Email Opt-out	Email Opt-out	Select the checkbox to remove the candidate from your mailing list so that they will not receive any emails from your Zoho Recruit account	Checkbox	-
Skill Set	Skill Set	Select the skill set of the candidate.	Text area (long text)	32000 characters
Street	Street	Specify the street address of the candidate.	Text box	Alphanumeric(250)
City	City	Specify the name of the city where the candidate lives.	Text box	Alphanumeric(30)
State	State	Specify the name of the state where the candidate lives.	Text box	Alphanumeric(30)
Zip Code	Zip Code	Specify the postal code of the candidate's address.	Numeric	Alphanumeric(30)
Country	Country	Specify the name of the candidate's country.	Text box	Alphanumeric(30)
Additional Info	Additional Info	Specify any other details about the candidate.	Text area (long text)	32000 characters
Linkedin	Linkedin	Specify the Linkedin url of the candidate	URL	Alphanumeric(255)
Facebook	Facebook	Specify the Facebook url of the candidate	URL	Alphanumeric(255)
Twitter	Twitter	Specify the twitter account details of the candidate.	Text box	Alphanumeric(50)
Modified By	Modified By	Specify the user who modified the candidate details.	Owner Lookup	-
Created By	Created By	Specify the user who added the candidate details.	Owner Lookup	-
Resume	Resume	Browse and attach the candidate resume from your system.	Upload Text
Formatted Resume	Formatted Resume	Browse and attach the candidate formatted resume from your system.	Upload Text
Cover Letter	Cover Letter	Browse and attach the candidate cover letter from your system.	Upload Text
Others	Others	Browse and attach any other details about the candidate from your system.	Upload Text

Clients

Field Name	API Format	Description	Data type	Maximum Limit
Client Name *	Client Name *	Specify the client name. This field is mandatory.	Text box	Alphanumeric(100)
Account Manager	Account Manager	Select the name of the user to whom the account is assigned.	Look up	-
Website	Website	Specify the URL of the company's website.	URL	Alphanumeric(30)
Source	Source	Select the source of the client i.e. from where the client is generated.	Pick list	-
Parent Client	Parent Client	Select the parent company name from the Change pop-up dialog.	Lookup	-
Created By	Created By	Specify the user who added the client details.	Owner Lookup	-
Modified By	Modified By	Specify the user who modified the client details.	Owner Lookup	-
Industry	Industry	Select the type of industry from the drop-down list.	Pick list	-
Client Contract	Client Contract	Browse and attach the client contract from your system.	Upload Text	-
Client Logo	Client Logo	Browse and attach the client logo from your system.	Upload Text	Number
Others	Others	Browse and attach any other details about the client.	Upload Text	Alphanumeric(30)
Contact Number	Contact Number	Specify phone number of the client.	Text box	Alphanumeric(30)
Fax	Fax	Specify the fax number of the client.	Text box	Alphanumeric(30)
Billing Address Street City State Code Country	Billing Address Street City State Code Country	Specify the billing address of the client to send the quotes, invoices, and other agreements.	Street - Text box City - Text box State - Text box Code - Text box Country- Text box	Alphanumeric(250) Alphanumeric(30) Alphanumeric(30) Alphanumeric(30) Alphanumeric(30)
Shipping Address Street City State Code Country	Shipping Address Street City State Code Country	Specify the shipping address of the client to deliver the shipment.	Street - Text box City - Text box State - Text box Code - Text box Country - Text box	Alphanumeric(250) Alphanumeric(30) Alphanumeric(30) Alphanumeric(30) Alphanumeric(30)
About	About	Specify details about the client.	Text area (long text)	32000 characters

Contacts

Field Name	API Format	Description	Data type	Maximum Limit
Contact Owner	Contact Owner	Select the Zoho Recruit user to whom the contact is assigned.	Lookup	-
Salutation	Salutation	Select the Salutation of the contact, such as Mr., Ms, Mrs., or others.	Pick list
First Name	First Name	Specify the first name of the contact.	Text box	Alphanumeric(40)
Last Name*	Last Name*	Specify the last name of the contact. This field is mandatory.	Text box	Alphanumeric(40)
Client Name	Client Name	Select the client related to the contact.	Lookup	-
Job Title	Job Title	Select the job position of the contact	Text box	Alphanumeric(100)
Created By	Created By	Specify the user who added the contact details.	Owner Lookup	-
Source	Source	Select the source from which the contact is created.	Pick list	-
Modified By	Modified By	Specify the user who modified the contact details.	Owner Lookup	-
Department	Department	Specify the department of the contact.	Text box	Alphanumeric(30)
Linkedin	Linkedin	Specify the Linkedin url of the candidate.	Text box	Alphanumeric(255)
Facebook	Facebook	Specify the Facebook url of the candidate.	Text box	Alphanumeric(255)
Twitter	Twitter	Specify the twitter account details of the contact.	Text box	Alphanumeric(50)
Email Opt Out	Email Opt Out	Select the checkbox to remove contacts from your mailing list so that they will not receive any emails from your Zoho Recruit account	Check box	-
Skype Id	Skype Id	Specify the Skype ID of the contact. Currently, Skype ID can be in the range of 6 to 32 characters.	Text box	Alphanumeric(50)
Work Phone	Work Phone	Specify the office phone number of the contact.	Text box	Alphanumeric(50)
Mobile	Mobile	Specify the mobile number of the contact.	Text box	Alphanumeric(50)
Fax	Fax	Specify the Fax number of the contact.	Text box	Alphanumeric(50)
Email	Email	Specify the primary email address of the contact.	Email	Alphanumeric(100)
Mailing Address Street City State Zip Country	Mailing Address Street City State Zip Country	Specify the primary address of the contact.	Street - Text box City - Text box State - Text box Code - Text box Country- Text box	Alphanumeric(250) Alphanumeric(30) Alphanumeric(30) Alphanumeric(30) Alphanumeric(30)
Other Address Street City State Zip Country	Other Address Street City State Zip Country	Specify the other address of the contact (if any).	Street - Text box City - Text box State - Text box Code - Text box Country - Text box	Alphanumeric(250) Alphanumeric(30) Alphanumeric(30) Alphanumeric(30) Alphanumeric(30)
Is Primary Contact	Is Primary Contact	Select the checkbox to assign the contact as the primary contact for that organization.	Check box	-
Others	Others	Browse and attach any other details about the contact.	Upload Text	-

Job Openings

Field Name	API Format	Description	Data type	Maximum Limit
Account Manager	Account Manager	Select the name of the user to whom the account is assigned.	Lookup	-
Posting Title*	Posting Title*	Specify name of the job opening. This field is mandatory.	Text box	Alphanumeric(120)
Client Name*	Client Name*	Select the name of the client for which the job opening has to be created. This field is mandatory.	Lookup	-
Job Opening ID	Job Opening ID	Specify the ID related to the job opening.	Auto Number	Alphanumeric(120)
Assigned Recruiter	Assigned Recruiter	Select the recruiter assigned to the job opening.	Lookup	-
Client Name	Client Name	Select the client related to the job opening.	Lookup	-
Contact Name	Contact Name	Select the contact related to the job opening.	Lookup	-
Rate	Rate	Specify the amount that can be expected after closing the job opening.	Currency	Decimal(16)
Target Date	Target Date	Specify or select the expected close date. This field is mandatory.	Date format	-
Number of Positions	Number of Positions	Specify the next step of the sales process.	Text box	Alphanumeric(100)
Stage	Stage	Select the sales stage from the drop-down list. This field is mandatory.	Pick list	-
Probability	Probability	Specify the probability of closing a job opening.	Integer	-
Expected Revenue	Expected Revenue	Calculated based on the amount and job opening stage specified.	Currency	Decimal(16)
Others	Others	Browse and upload any other details about the job opening.	Upload Text	-
Job Opening Status	Job Opening Status	Select the status of the job opening.	Pick list	-
Date Opened	Date Opened	Specify the date in which the job opening was entered.	Date format	-
Industry	Industry	Select the type of industry from the drop-down list.	Pick list	-
Job Type	Job Type	Select the type of job from the drop-down list.	Pick list	-
State	State	Specify the state related to the job opening.	Text box	Alphanumeric(120)
City	City	Specify the city related to the job opening.	Text box	Alphanumeric(120)
Work Experience	Work Experience	Specify the work experience required for the job opening.	Pick List	-
Country	Country	Specify the country related to the job opening.	Text box	Alphanumeric(120)
Modified By	Modified By	Specify the user who modified the job opening details.	Owner Lookup	-
Salary	Salary	Specify the salary related to the job opening.
Job Description	Job Description	Specify the job description.	Text area (long text)	32000 characters
Job Summary	Job Summary	Browse and upload the job summary.	Upload Text	-

Tasks

Field Name	API Format	Description	Data type	Maximum Limit
Task Owner	Task Owner	Select the name of the user to whom the task is assigned.	Lookup
Subject*	Subject*	Specify the name of the task. This field is mandatory.	Text box	Alphanumeric(50)
Due Date	Due Date	Specify the due date for the task	Date
Contacts/Candidates	Contacts/Candidates	Select the related contact or candidate	Lookup
Contact Name	Job Opening/Interview/Client	Select any other record related to the task	Lookup	-
Status	Status	Specify the status of the task	Pick List	-
Priority	Priority	Select the due date.	Date	-
Send Notification Email	Send Notification Email	Select the check box to send notification email to the task owner	Check box
Remind At	Remind At	Select the check box to set reminder for the task	Check box
Recurring Activity	Recurring Activity	Select the check box to mark it as a recurring activity	Check box	-
Description	Description	Specify the details about the task	Text area (long text)	32000 characters
Created By	Created By	Specify the user who added the task details.	Owner Lookup	-
Modified By	Modified By	Specify the user who modified the task details.	Owner Lookup	-

Events

Field Name	API Format	Description	Data type	Maximum Limit
Event Owner	Event Owner	Select the name of the user to whom the event is assigned.	Lookup
Subject*	Subject*	Specify the name of the event. This field is mandatory.	Text box	Alphanumeric(50)
Start Date Time*	Start DateTime*	Specify the date and time when the event will be started. This field is mandatory.	Date and Time
End Date Time *	End DateTime *	Specify the date and time when the event will be over. This field is mandatory.	Date and Time
Venue	Venue	Enter the venue for the event	Text
Contacts/Candidates	Contacts/Candidates	Select the related contact or candidate	Lookup
Related To	Related To	Select any other record related to the event	Lookup	-
Remind At	Remind At	Select the check box to set reminder for the event	Check box
Recurring Activity	Recurring Activity	Select the check box to mark it as a recurring activity	Check box	-
Description	Description	Specify the details about the event	Text area (long text)	32000 characters

Calls

Field Name	API Format	Description	Data type	Maximum Limit
Subject*	Subject*	Specify the subject of the call. This field is mandatory.	Text box	Alphanumeric(50)
Call Type*	Call Type*	Choose whether the call is inbound or outbound.
Call Purpose	Call Purpose	Select the purpose of the call.	Pick List
Call From/To	Call From/To	Choose Contact or Candidate.		-
Related To	Related To	Select the record to which the call is related to.	Pick List	-
Call Details	Call Details	Select whether it is a Current call, Completed call or Schedule Call.		-
Call Start Time	Call Start Time	Automatically displays the call start date and time.	Pick List
Call Duration	Call Duration	Specify the duration of the call.	Integer
Description	Description	Specify the details about the task.	Text area (long text)	32000 characters
Billable	Billable	Select the check box if the call is considered for billing.	Check box
Call Result	Call Result	Enter the call result.	Text

Interviews

Field Name	API Format	Description	Data type	Maximum Limit
Interview Name*	Interview Name*	Specify the subject of the interview. This field is mandatory.	Text box	Alphanumeric(120)
Candidate Name*	Candidate Name*	Specify the candidate name.	Lookup	-
Client Name	Client Name	Specify the client name.	Lookup	-
Posting Title	Posting Title	Specify the job opening title.	Lookup	-
Interviewer	Interviewer	Specify the user who is going to conduct the interview	Lookup	-
Type	Type	Select the type of interview.	Pick list	-
Interview Start Time*	Interview Start Time*	Specify the interview start date and time.	Date Time	-
Interview End Time*	Interview End Time*	Specify the interview end date and time.	Date Time	-
Schedule Comments	Schedule Comments	Specify details about the interview.	Text area (long text)	32000 characters
Location	Location	Select the location of the interview.	Text box	Alphanumeric(120)
Interview Owner	Interview Owner	The interview owner is automatically displayed.
Others	Others	Browse and attach any other details about the interview from your system.	Upload Text	-

Note:

Using API, you cannot create or update these system-generated fields:

Created By
Modified By
Created Time
Modified Time
Formula type custom fields
Auto-number type custom fields

Access your files securely from anywhere

Zoho CRM Training Programs

Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

Redefine the way you work

with Zoho Workplace

Start your free trial

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.

Create, share, and deliver

beautiful slides from anywhere.

Get Started Now

Zoho Sign now offers specialized one-on-one training for both administrators and developers.

BOOK A SESSION

Zoho Workerly Home
Forums
Connect With Us:

Zoho Recruit Home
Forums
Connect With Us:

Start tracking your website metrics today

Use PageSense to understand what your visitors are looking for, how they are behaving, and where they are facing problems on your website.

Ready to improve your website's performance?

Install the PageSense code snippet on your site in a matter of minutes and start collecting in-depth data about the website visitors to grow your business.

Track and measure every business goal

Set up goals in PageSense to measure every single action performed by visitors on your website like button or link clicks, form submissions, and page engagements.

Understand the customer journey on your website

Create funnels in PageSense to quickly see which pages visitors use to enter your website, where they navigate to next, and which pages they decide to leave without converting.

Visualize your visitor's behavior with color codes

Set up heatmaps in PageSense to see where users have clicked more, how far they've scrolled, and on which parts of a page they've spent the most time using color-coded patterns in reports.

Measure customer engagement with your web forms

Use form analytics in PageSense to see how people interact with different fields in your form, whether they complete the form successfully or not, and where exactly they drop out on your form.

Record real visitor interactions on your website

Use session recordings in PageSense to watch a video of all the visitor actions performed on your website including the pages they navigate, the buttons they click, the UX issues they face, and more.

Test and optimize webpages for better conversions

Run A/B or Split URL tests in PageSense to figure out which version of your web page works best for your business and results in the best conversion rate.

Give each customer a unique website experience

Use personalization in PageSense to deliver customized versions of your website for every individual customer based on their demographics, local weather, browsing history, and more.

Grow your business through customer feedback

Run polls on your website using PageSense to understand what your customers think about your products/services and what needs improvement on your site.

Send timely updates that customers love

Use web push notifications in PageSense to schedule and notify your customers about an upcoming flash sale, product releases, promotional coupons, and a lot more that can spark conversions on your website.

Advertise your business to website visitors

Use pop-ups in PageSense to instantly grab the attention of visitors by showing attractive signup offers, coupon code discounts, or email newsletters that can eventually convert them into subscribers.

Access more advanced settings in PageSense

Use PageSense's advanced features like creating mutually exclusive groups, enabling cross-domain tracking, configuring customized project JS, and more to get deeper insights about your website.

Try easy-to-use extensions

Download the PageSense extension app available for your web browser with a few clicks and start collecting all of your required website metrics in real time.

Discover your favorite integrations with PageSense

Get a deeper look at your website's data by seamlessly integrating PageSense with a host of popular third-party apps like Google Analytics, Mixpanel, Intercom, and more.

Quick Links	Workflow Automation	Data Collection
Web Forms	Enterprise	Begin Data Collection
Interactive Forms	Workplace	Data Collection App
Offline Forms	Customer Service	Accessible Forms
Digital Forms	Marketing	Forms for Small Business
HTML Forms	Education	Forms for Enterprise
Contact Forms	E-commerce	Forms for any business
Lead Generation Forms	Healthcare	Forms for Startups
Wordpress Forms	Customer onboarding	Order Forms for Small Business
No Code Forms	Construction
Free Forms	Travel
Prefill Forms	Non-Profit
Intake Forms	Legal
Form Designer	HR
Card Forms	Food
Assign Forms	Photography
Translate Forms	Real Estate
Electronic Forms
Notification Emails for Forms
Holiday Forms
Form to PDF
Email Forms CRM Forms Embeddable Forms Drag and Drop form builder HIPAA Forms Encrypted Forms

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

Zoho Pagesense Resources

You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.

New to Zoho Survey?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho Social?

Manage your brands on social media

Access Zoho Social

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Zoho Sheet Resources

New to Zoho Forms?

Latest Feature Updates

Explore our Pricing & Plans

Zoho Forms Resources

Secure your business

communication with Zoho Mail

Get started

Mail on the move with

Zoho Mail mobile application

Go Mobile

Stay on top of your schedule

at all times

Get started

Carry your calendar with you

Anytime, anywhere

Get started

Latest Announcements

New to Zoho Sign?

Zoho Sign Resources

Sign, Paperless!

Sign and send business documents on the go!

Get Started Now

Zoho SalesIQ Resources

New to Zoho TeamInbox?

Zoho TeamInbox Resources

Connect with us

New to Zoho ZeptoMail?

LEARN MORE

Latest Feature Updates

Zoho DataPrep Resources

New to Zoho DataPrep?

Access Zoho DataPrep

Zoho DataPrep Demo

Get a personalized demo or POC

Design. Discuss. Deliver.

Create visually engaging stories with Zoho Show.

Get Started Now

New to Zoho Workerly?

Access Zoho Workerly

New to Zoho Recruit?

Access Zoho Recruit

New to Zoho CRM?

Signup Now

Access Zoho CRM

Latest Feature Updates

New to Zoho Projects?

Access Zoho Projects

New to Zoho Sprints?

Access Zoho Sprints

New to Zoho Assist?

Access Zoho Assist

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Related Articles
Map Zoho Recruit Modules and Fields with Zoho CRM
Before syncing data from Zoho CRM, you need to map the Zoho Recruit modules and fields with the corresponding ones from Zoho CRM. To map Zoho Recruit modules with Zoho CRM: Navigate to Setup > Marketplace > Zoho Apps > Zoho CRM. Select either 1-way ...
Standard Fields in Forecasts
Following are the list of Zoho defined standard fields available in the Forecasts module: Field Name Description Year Select the fiscal year from the drop-down list. Forecast Period The period for which you can create forecasts can be either ...
Standard Fields in Candidates
Following are the list of Zoho defined standard fields available in the Candidates module: Field Name Description Data type Maximum Limit Candidate Owner Select the Zoho Recruit user to whom the candidate is assigned. Lookup - Salutation Select the ...
Standard Fields in Contacts
Following are the list of Zoho defined standard fields available in the Contacts module: Field Name Description Data type Maximum Limit Contact Owner Select the Zoho Recruit user to whom the account is assigned. Lookup - Salutation Select the ...
Standard Fields in Clients
Following are the list of Zoho defined standard fields available in the Clients module: Field Name Description Data type Maximum Limit Client Name Specify the company name. This field is mandatory. Text box Alphanumeric(100) Client Owner Select the ...