Recruit Modules & Fields

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

Standard ModuleAPI Format
CandidatesCandidates
ClientsClients
ContactsContacts
Job OpeningsJobOpenings
TasksTasks
EventsEvents
CallsCalls
InterviewsInterviews

Note:

  1. API support is not available for the Forecasts module.
  2. 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.
  3. 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 NameAPI FormatDescriptionData typeMaximum Limit
Candidate OwnerCandidate OwnerSelect the Zoho Recruit user to whom the Candidate is assigned.Lookup-
SalutationSalutationSelect the salutation from the drop-down list.Pick list-
First NameFirst NameSpecify the first name of the candidate.Text boxAlphanumeric(40)
Candidate IDCandidate IDSpecify the ID of the candidate.Auto numberAlphanumeric(120)
Last Name*Last Name*Specify the last name of the candidate. This field is a mandatory.Text boxAlphanumeric(80)
Experience in YearsExperience in YearsSpecify the working experience in years of the candidate.Double-
SourceSourceSelect the source of the candidate i.e. from where the candidate is generated.Pick list-
Highest Qualification HeldHighest Qualification HeldSelect the highest qualification held by the candidate.Pick list-
Current Job TitleCurrent Job TitleSpecify the current job title of the candidatePick list-
PhonePhoneSpecify the phone number of the candidate.Text boxAlphanumeric(30)
MobileMobileSpecify the mobile number of the candidate.Text boxAlphanumeric(30)
FaxFaxSpecify the fax number of the candidate.Text boxAlphanumeric(30)
EmailEmailSpecify the email address of the candidate.EmailAlphanumeric and Special characters(100)
Current EmployerCurrent EmployerSpecify the current employer of the candidate.Text boxAlphanumeric(100)
Skype IDSkype IDSpecify the Skype ID of the candidate. Currently, Skype ID can be in the range of 6 to 32 characters.Text boxAlphanumeric(50)
WebsiteWebsiteSpecify the website of the candidate.URLAlphanumeric(120)
Candidate StatusCandidate StatusSelect the status of the candidate from the drop-down list.Pick list-
Expected SalaryExpected SalarySelect the expected salary of the candidate.CurrencyDecimal(16)
Current SalaryCurrent SalarySelect the current salary of the candidate.CurrencyDecimal(16)
Email Opt-outEmail Opt-outSelect the checkbox to remove the candidate from your mailing list so that they will not receive any emails from your Zoho Recruit accountCheckbox-
Skill SetSkill SetSelect the skill set of the candidate.Text area (long text)32000 characters
StreetStreetSpecify the street address of the candidate.Text boxAlphanumeric(250)
CityCitySpecify the name of the city where the candidate lives.Text boxAlphanumeric(30)
StateStateSpecify the name of the state where the candidate lives.Text boxAlphanumeric(30)
Zip CodeZip CodeSpecify the postal code of the candidate's address.NumericAlphanumeric(30)
CountryCountrySpecify the name of the candidate's country.Text boxAlphanumeric(30)
Additional InfoAdditional InfoSpecify any other details about the candidate.Text area (long text)32000 characters
TwitterTwitter Specify the twitter account details of the candidate.Text box  Alphanumeric(50)
Modified ByModified By Specify the user who modified the candidate details.Owner Lookup -
Created ByCreated By Specify the user who added the candidate details.Owner Lookup -
ResumeResume  Browse and attach the candidate resume from your system.Upload Text 
Formatted ResumeFormatted 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 
OthersOthers  Browse and attach any other details about the candidate from your system.Upload Text 

Clients

Field NameAPI FormatDescriptionData typeMaximum Limit
Client Name *Client Name *Specify the client name. This field is mandatory.Text boxAlphanumeric(100)
Account ManagerAccount ManagerSelect the name of the user to whom the account is assigned.Look up-
WebsiteWebsiteSpecify the URL of the company's website.URLAlphanumeric(30)
SourceSourceSelect the source of the client i.e. from where the client is generated.Pick list-
Parent ClientParent ClientSelect the parent company name from the Change pop-up dialog.Lookup-
Created ByCreated BySpecify the user who added the client details.Owner Lookup-
Modified ByModified BySpecify the user who modified the client details.Owner Lookup-
IndustryIndustrySelect the type of industry from the drop-down list.Pick list-
Client ContractClient ContractBrowse and attach the client contract from your system.Upload Text-
Client LogoClient LogoBrowse and attach the client logo from your system.Upload TextNumber
OthersOthersBrowse and attach any other details about the client.Upload TextAlphanumeric(30)
Contact NumberContact NumberSpecify phone number of the client.Text boxAlphanumeric(30)
FaxFaxSpecify the fax number of the client.Text boxAlphanumeric(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)
AboutAboutSpecify details about the client.Text area (long text)32000 characters
 

Contacts

Field NameAPI FormatDescriptionData typeMaximum Limit
Contact OwnerContact OwnerSelect the Zoho Recruit user to whom the contact is assigned.Lookup-
SalutationSalutationSelect the Salutation of the contact, such as Mr., Ms, Mrs., or others.Pick list 
First NameFirst NameSpecify the first name of the contact.Text boxAlphanumeric(40)
Last Name*Last Name*Specify the last name of the contact. This field is mandatory.Text boxAlphanumeric(40)
Client NameClient NameSelect the client related to the contact.Lookup-
Job TitleJob TitleSelect the job position of the contactText boxAlphanumeric(100)
Created ByCreated BySpecify the user who added the contact details.Owner Lookup-
SourceSourceSelect the source from which the contact is created.Pick list-
Modified ByModified BySpecify the user who modified the contact details.Owner Lookup-
DepartmentDepartmentSpecify the department of the contact.Text boxAlphanumeric(30)
TwitterTwitterSpecify the twitter account details of the contact.Text box Alphanumeric(50)
Email Opt OutEmail Opt OutSelect the checkbox to remove contacts from your mailing list so that they will not receive any emails from your Zoho Recruit accountCheck box-
Skype IdSkype IdSpecify the Skype ID of the contact. Currently, Skype ID can be in the range of 6 to 32 characters.Text boxAlphanumeric(50)
Work PhoneWork PhoneSpecify the office phone number of the contact.Text boxAlphanumeric(50)
MobileMobileSpecify the mobile number of the contact.Text boxAlphanumeric(50)
FaxFaxSpecify the Fax number of the contact.Text boxAlphanumeric(50)
EmailEmailSpecify the primary email address of the contact.EmailAlphanumeric(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 ContactIs Primary ContactSelect the checkbox to assign the contact as the primary contact for that organization.Check box-
OthersOthersBrowse and attach any other details about the contact.Upload Text-

Job Openings

Field NameAPI FormatDescriptionData typeMaximum Limit
Account ManagerAccount ManagerSelect 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 boxAlphanumeric(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 IDJob Opening IDSpecify the ID related to the job opening.Auto NumberAlphanumeric(120)
Assigned RecruiterAssigned RecruiterSelect the recruiter assigned to the job opening.Lookup-
Client NameClient NameSelect the client related to the job opening.Lookup-
Contact NameContact NameSelect the contact related to the job opening.Lookup-
RateRateSpecify the amount that can be expected after closing the job opening.CurrencyDecimal(16) 
Target DateTarget DateSpecify or select the expected close date. This field is mandatory.Date format-
Number of PositionsNumber of PositionsSpecify the next step of the sales process.Text boxAlphanumeric(100)
StageStageSelect the sales stage from the drop-down list. This field is mandatory.Pick list-
ProbabilityProbabilitySpecify the probability of closing a job opening.Integer
Expected RevenueExpected RevenueCalculated based on the amount and job opening stage specified.CurrencyDecimal(16) 
OthersOthersBrowse and upload any other details about the job opening.Upload Text-
Job Opening StatusJob Opening StatusSelect the status of the job opening.Pick list-
Date OpenedDate OpenedSpecify the date in which the job opening was entered.Date format-
IndustryIndustrySelect the type of industry from the drop-down list.Pick list
Job TypeJob TypeSelect the type of job from the drop-down list.Pick list-
StateStateSpecify the state related to the job opening. Text boxAlphanumeric(120)
CityCitySpecify the city related to the job opening.Text boxAlphanumeric(120)
Work ExperienceWork ExperienceSpecify the work experience required for the job opening.Pick List-
CountryCountrySpecify the country related to the job opening.Text boxAlphanumeric(120)
Modified ByModified BySpecify the user who modified the job opening details.Owner Lookup-
SalarySalarySpecify the salary related to the job opening.  
Job DescriptionJob DescriptionSpecify the job description.Text area (long text) 32000 characters
Job SummaryJob SummaryBrowse and upload the job summary.Upload Text -

Tasks

Field NameAPI FormatDescriptionData typeMaximum Limit
Task OwnerTask OwnerSelect 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 boxAlphanumeric(50)
Due DateDue DateSpecify the due date for the taskDate 
Contacts/CandidatesContacts/CandidatesSelect the related contact or candidateLookup 
Contact NameJob Opening/Interview/ClientSelect any other record related to the taskLookup-
StatusStatusSpecify the status of the taskPick List-
PriorityPrioritySelect the due date.Date-
Send Notification EmailSend Notification EmailSelect the check box to send notification email to the task ownerCheck box 
Remind AtRemind AtSelect the check box to set reminder for the taskCheck box 
Recurring ActivityRecurring ActivitySelect the check box to mark it as a recurring activityCheck box-
DescriptionDescriptionSpecify the details about the taskText area (long text)32000 characters
Created ByCreated BySpecify the user who added the task details.Owner Lookup-
Modified ByModified BySpecify the user who modified the task details.Owner Lookup-

Events

Field NameAPI FormatDescriptionData typeMaximum Limit
Event OwnerEvent OwnerSelect 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 boxAlphanumeric(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 
VenueVenueEnter the venue for the eventText 
Contacts/CandidatesContacts/CandidatesSelect the related contact or candidateLookup 
Related ToRelated ToSelect any other record related to the eventLookup-
Remind AtRemind AtSelect the check box to set reminder for the eventCheck box 
Recurring ActivityRecurring ActivitySelect the check box to mark it as a recurring activityCheck box-
DescriptionDescriptionSpecify the details about the eventText area (long text)32000 characters

Calls

Field NameAPI FormatDescriptionData typeMaximum Limit
Subject*Subject*Specify the subject of the call. This field is mandatory.Text boxAlphanumeric(50)
Call Type*Call Type*Choose whether the call is inbound or outbound.  
Call PurposeCall PurposeSelect the purpose of the call.Pick List 
Call From/ToCall From/ToChoose Contact or Candidate. -
Related ToRelated ToSelect the record to which the call is related to.Pick List-
Call DetailsCall DetailsSelect whether it is a Current call, Completed call or Schedule Call. -
Call Start TimeCall Start TimeAutomatically displays the call start date and time.Pick List 
Call DurationCall DurationSpecify the duration of the call.Integer 
DescriptionDescriptionSpecify the details about the task.Text area (long text)32000 characters
BillableBillableSelect the check box if the call is considered for billing.Check box 
Call ResultCall ResultEnter the call result.Text 

Interviews

Field NameAPI FormatDescriptionData typeMaximum Limit
Interview Name*Interview Name*Specify the subject of the interview. This field is mandatory.Text boxAlphanumeric(120)
Candidate Name*Candidate Name*Specify the candidate name.Lookup-
Client NameClient NameSpecify the client name.Lookup-
Posting TitlePosting TitleSpecify the job opening title.Lookup-
InterviewerInterviewerSpecify the user who is going to conduct the interviewLookup-
TypeTypeSelect 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 CommentsSchedule CommentsSpecify details about the interview.Text area (long text)32000 characters
LocationLocationSelect the location of the interview.Text boxAlphanumeric(120)
Interview OwnerInterview OwnerThe interview owner is automatically displayed.  
 
OthersOthersBrowse 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:

  1. Created By
  2. Modified By
  3. Created Time
  4. Modified Time
  5. Formula type custom fields
  6. Auto-number type custom fields