The Zoho Recruit API is available in all editions of Zoho Recruit. To use the API, you'll require the Zoho Recruit Authentication Token from your Recruit account. Please make sure that you have the permission to access the API service. If you do not have permission, please contact your Recruit administrator.

Generate Auth Token

To generate the Auth Token, you need to send an authentication request to Zoho Accounts using the URL format below.

Important Notes:

The user must be a confirmed user, else while generating the Auth Token the user will receive an error - "ACCOUNT_REGISTRATION_NOT_CONFIRMED".

URL Format

API Mode:

https://accounts.zoho.com/apiauthtoken/nb/create?SCOPE=ZohoRecruit/recruitapi&EMAIL_ID=Zoho Recruit Username or Email ID&PASSWORD=Your Zoho Recruit Password

Using Two-factor Authentication?

If you're using the two-factor authentication to access your Zoho Recruit account, follow these steps to generate the Auth Token in API mode:

  1. Log in to Zoho Recruit.
  2. Open https://accounts.zoho.com.
  3. In the Zoho Accounts Home page, click Two Factor Authentication.
  4. In the Two Factor Authentication page, click on the Manage Application Specific Passwords.
  5. In the Application Specific Passwords pop-up, specify these details:
    1. Device or App Name
    2. Current Password
    3. Click Generate.
      You will receive the new application-specific password with spaces.
  6. Remove the spaces in the password and include it in the below URL:

    https://accounts.zoho.com/apiauthtoken/nb/create?SCOPE=ZohoRecruit/recruitapi&EMAIL_ID=username&PASSWORD=application_password

Parameters to be passed along with this URL are:

ParameterDescription
EMAIL_IDSpecify your Zoho Recruit Username or Email ID
scopeSpecify the value as ZohoRecruit/recruitapi
PASSWORDSpecify your Zoho Recruit Password

For more information, please refer Two-factor Authentication help page.

Browser Mode:

Log in to Zoho Recruit in a new window and use the following URL:

 https://accounts.zoho.com/apiauthtoken/create?SCOPE=ZohoRecruit/recruitapi

If you are a Google Apps User, you can log into your Recruit account and then use the browser mode format to generate the Authentication Token.

Sample Response

#
#Wed Feb 29 03:07:33 PST 2012
AUTHTOKEN=bad18eba1ff45jk7858b8ae88a77fa30
RESULT=TRUE

Note:
  1. The Auth Token can be used in all your API calls. You can also see the URL format under Setup > Developer Space > Recruit API.
  2. You need to be logged into your Recruit account to use the Browser Mode.

Example

Here's an example to fetch records:

Manage Auth Tokens

You can viewdelete and regenerate the Auth Token generated for your account from the 'My Zoho Account' Page.

  1. Log in to Zoho Recruit.
  2. Open [Username] > My Zoho Account.
  3. In the My Zoho Account page, click Settings > Active Authtokens.
    In this page, you can also Remove or Regenerate Auth Tokens.
     

Note:

  1. Removing an Auth Token will delete the token permanently.
  2. If you regenerate Auth Token, update your program with the new token.

Important Notes

  1. The Auth Token is user-specific and is a permanent token.
  2. On deletion, the existing token will be deleted permanently. The new token has to be replaced for all API calls.
  3. The Auth Token of a user's account will become invalid if the user is deactivated.