Zoho Recruit API

Zoho Recruit - Applicant Tracking System provides API (Application Programming Interface) to all its partners, customers and developers. Now you can integrate Zoho Recruit modules with any Zoho services, third party applications, portals or websites, and customize as per your needs. With Zoho Recruit API you can extract Zoho Recruit data in XML or JSON format. Our API is available in all editions.

You can use Zoho Recruit API to integrate the following types of Application:

  • Zoho Services
  • Third-party applications

Zoho Recruit supports the following API methods:

Note: Zoho Recruit API's support https protocol only.

Generate API KEY (apikey)

Login to https://zapi.zoho.com to get your API Key, which you need to pass with every API request.

Generate Ticket ID (ticket)

While initiating API request, you must pass the ticket parameter (encrypted alphanumeric string) to authenticate the user credentials with Zoho. To generate a ticket for a particular user, you need to send an authenticated HTTPS POST request over a secured connection to Zoho Accounts.

Give the username and password of "Recruiter-Admin" role

Sample form POST format with supported parameters:

<form method="POST" action="https://accounts.zoho.com/login" target="_self">
<input type="hidden" name="LOGIN_ID" value="[ZOHO ID or Email ID]">
<input type="hidden" name="PASSWORD" value="[Password for ZOHO ID]">
<input type="hidden" name="FROM_AGENT" value="true">
<input type="hidden" name="servicename" value="zohopeople">
<input type="submit" value="Get Ticket ID" class="divbutton" name="submit">
</form>
 

Prerequisite

  • You must have a valid user name and password to access the Zoho Recruit service
  • Only "Recruiter-Admin will be able to access all Zoho Recruit API's
  • Developer environment/hosting server to integrate third-party application
  • Internet connection to communicate with Zoho Recruit API

Sample URL format with supported parameters

https://accounts.zoho.com/login?servicename=zohopeople&FROM_AGENT=true&LOGIN_ID=Zoho Username or Email Address&PASSWORD=Password

The mandatory parameters along with their values to be passed in the URL are:
Parameter Type Description
servicename zohopeople Specify the service name is zohopeople
FROM_AGENT Boolean True
LOGIN_ID String User's Zoho ID or Email Address
PASSWORD String Password for the Zoho ID

Depending on the parameters passed over to the requested URL, you will get a response in the format given below:

Parameter Type Description
Comment String Ticket generated date & time
GETUSERNAME    
WARNING String If the parameters passed in the URL are incorrect, the user will get a warning message stating the same otherwise the value will be null.
PASS_EXPIRY Integer Displays duration of the password expiry. You will get the value as -1, if the password expiry is not set for your Zoho account.
TICKET String Ticket generated for the request (32 characters)
RESULT Boolean Value is TRUE if the ticket is generated successfully, else it is FALSE.

Example 1: Successful Ticket Generation Pattern
# #Thu Apr 01 20:29:06 PDT 2010 
GETUSERNAME=null 
WARNING=null 
PASS_EXPIRY=-1 
TICKET=5767ef44382712202e432d57da576b34 
RESULT=TRUE

Get the TICKET from the RESPONSE above.

Example 2: Failure Ticket Generation Pattern

# #Thu Apr 01 20:34:34 PDT 2010 
CAUSE=Username and Password do not match 
RESULT=FALSE

Important Notes:

  • Your API ticket is valid for 7 days. After 7th day, you must generate a new ticket to work with Zoho Recruit - API service. If you are not updating the application with a new ticket ID, you will receive 4834 - Invalid Ticket ID error response from API request
  • You are strongly recommended not to generate API ticket for every API request. You can use the same ticket in your application for 7 days without any issues.

Automate your Recruitment Process

Track Openings, Resumes, Candidates and Clients

Follow us on Twitter
Become a fan on Facebook