Connecting to ZohoRecruit

To authenticate to ZohoRecruit, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

Using OAuth Authentication

First, you will need to register an OAuth application with ZohoRecruit. To do so, go to the Zoho Developer Console, add a new Client (Server-based application) and set a valid OAuth redirect URL. Your OAuth application will be assigned a client id and a client secret. Additionally, you will need to set the relevant Domain (.com, .eu, .in, .com.cn, or .jp), which defaults to .com.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuth.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• OAuthClientId: Set this to the client_id that is specified in your app settings.
• OAuthClientSecret: Set this to the client_secret that is specified in your app settings.
• CallbackURL: Set this to the Redirect URI that is specified in your app settings.
• Domain: Set this in ProfileSettings to your ZohoRecruit account domain (e.g. .com, .eu, .in, .com.cn, .jp).

Example connection string:

Profile=C:\profiles\ZohoRecruit.apip;ProfileSettings='Domain=.com';AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Available Tables

The ZohoRecruit API Profile provides access to recruitment and staffing data across 8 specialized tables:

• Candidates - Access candidate profiles with personal details, contact information, work experience, education, skills, and pipeline status.
• JobOpenings - Query job opening records with position details, status, client association, recruiter assignments, and salary information.
• Contacts - Retrieve contact records associated with client companies including job title, address, communication details, and portal status.
• Clients - Access client company records with billing and shipping addresses, industry classification, account manager, and associated contact counts.
• Interviews - Query interview scheduling records with candidate and job opening associations, interviewer details, location, and status.
• Notes - Retrieve notes attached to any module record (Candidates, Job Openings, Contacts, Clients, or Interviews) with title and content.
• Attachments - Access file attachments linked to module records with file name, size, and upload metadata.
• Users - Query ZohoRecruit user accounts with profile, role, locale, and account status information.

Usage Examples

Attachments:

SELECT * FROM Attachments WHERE Module = 'Candidates' AND ParentId = '123456789012345'

Candidates:

SELECT * FROM Candidates WHERE Email = '[email protected]'

Clients:

SELECT * FROM Clients WHERE Id = '123456789012345'

Contacts:

SELECT * FROM Contacts WHERE Email = '[email protected]'

Interviews:

SELECT * FROM Interviews WHERE Id = '123456789012345'

JobOpenings:

SELECT * FROM JobOpenings WHERE Id = '123456789012345'

Notes:

SELECT * FROM Notes WHERE SeModule = 'Candidates' AND ParentId = '123456789012345'

Users:

SELECT * FROM Users

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are OAuth. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
CallbackURL	Identifies the URL users return to after authenticating to API via OAuth (Custom OAuth applications only).
Domain	Determines the domain where authentication calls will be sent to. Allowed values are: MIXPANEL, EU.MIXPANEL, IN.MIXPANEL, .COM, .EU, .COM.AU, .IN, COM, EU, COM.AU, IN, .COM.CN, .JP
InitiateOAuth	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. Allowed values are: OFF, REFRESH, GETANDREFRESH
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Scope(s) to use when authenticating, that control access to specific information.