-None-NewWaiting-for-EvaluationQualifiedUnqualifiedJunk candidateContactedContact in FutureNot ContactedAttempted to ContactAssociatedSubmitted-to-clientApprov ``` -------------------------------- ### GET /recruit/private/json/Info/getModules Source: https://help.zoho.com/portal/en/kb/recruit/developer-guide/api-methods/articles/getmodules Retrieves a list of all available modules within your Zoho Recruit account. This method supports both authentication methods: AuthToken and OAuth. ```APIDOC ## GET /recruit/private/json/Info/getModules ### Description This endpoint allows you to retrieve a list of all modules available in your Zoho Recruit account. It is useful for understanding the structure and available features within your account. ### Method GET ### Endpoint `https://recruit.zoho.com/recruit/private/json/Info/getModules` ### Parameters #### Query Parameters - **authtoken** (String) - Required - Encrypted alphanumeric string to authenticate your Zoho credentials. - **scope** (String) - Required - Specify the value as `recruitapi`. - **version** (Integer) - Optional - Use `version=2` for the latest API implementation. #### OAuth Authentication Headers - **Authorization** (String) - Required - `Zoho-oauthtoken {access_token}` - **Scope** (String) - Required - `ZohoRecruit.modules.all` or `ZohoRecruit.modules.{scope_name}.{operation_type}` ### Request Example ```json { "authtoken": "YOUR_AUTH_TOKEN", "scope": "recruitapi", "version": 2 } ``` ### Response #### Success Response (200) - **row** (Object) - Represents a module with its details. - **no** (String) - Sequential number for the row. - **id** (String) - Unique identifier for the module. - **pl** (String) - Plural name of the module. - **sl** (String) - Singular name of the module. - **gt** (String) - Module type indicator. #### Response Example ```json { "response": { "result": { "row": [ { "no": "1", "id": "xxxx000000002xxx", "pl": "Job Openings", "sl": "Job Opening", "gt": "1", "content": "Job Openings" }, { "no": "2", "id": "xxxx000000002xxx", "pl": "Candidates", "sl": "Candidate", "gt": "1", "content": "Candidates" } ] } } } ``` ``` -------------------------------- ### Insert Notes in Zoho Recruit (XML) Source: https://help.zoho.com/portal/en/kb/recruit/developer-guide/api-methods/articles/addrecords This example demonstrates how to insert notes into Zoho Recruit and relate them to primary modules like Candidates or Contacts. It uses the `addRecords` API for Notes and requires the `entityId` of the primary record, `Note Type`, and `Type Id`. ```xml 6000000119069Meeting6000000021005Candidates ``` -------------------------------- ### GET /recruit/private/json/Candidates/getAssociatedJobOpenings Source: https://help.zoho.com/portal/en/kb/recruit/developer-guide/api-methods/articles/getassociatedjobopenings Retrieves data for job openings associated with candidates from third-party applications. Supports both authtoken and OAuth authentication. ```APIDOC ## GET /recruit/private/json/Candidates/getAssociatedJobOpenings ### Description Retrieves the data of job openings associated with candidates from third-party applications. ### Method GET ### Endpoint `https://recruit.zoho.com/recruit/private/json/Candidates/getAssociatedJobOpenings` ### Parameters #### Query Parameters - **authtoken** (String) - Required - Encrypted alphanumeric string to authenticate your Zoho credentials. - **scope** (String) - Required - Specify the value as `recruitapi`. - **version** (Number) - Required - API version number (e.g., 2). - **id** (String) - Optional - The ID of the candidate to retrieve associated job openings for. #### Authentication **1. Authtoken Authentication:** - Use the `authtoken` query parameter. **2. OAuth Authentication:** - Use the `Authorization` header with the value `Zoho-oauthtoken {access_token}`. - Required Scope: `ZohoRecruit.modules.all` or `ZohoRecruit.modules.{scope_name}.{operation_type}` (e.g., `ZohoRecruit.modules.jobopening.READ`). ### Request Example ``` https://recruit.zoho.com/recruit/private/json/Candidates/getAssociatedJobOpenings?authtoken=AUTHTOKEN&scope=recruitapi&id=50000000033013 ``` ### Response #### Success Response (200) - **JOBOPENINGID** (String) - The ID of the associated job opening. - **STATUS** (String) - The status of the association (e.g., 'Associated', 'Submitted-to-client'). #### Response Example (JSON) ```json { "response": { "uri": "/recruit/internal/json/Candidates/getAssociatedJobOpenings", "result": { "Candidates": { "row": [ { "FL": [ { "val": "JOBOPENINGID", "content": "317865000000088095" }, { "val": "STATUS", "content": "Associated" } ] }, { "FL": [ { "val": "JOBOPENINGID", "content": "317865000000088091" }, { "val": "STATUS", "content": "Associated" } ] } ] } } } } ``` ``` -------------------------------- ### Add Zoho Recruit Events via API Source: https://help.zoho.com/portal/en/kb/recruit/developer-guide/api-methods/articles/addrecords This example demonstrates adding an event record to Zoho Recruit via the API. It includes event subject, date/time, venue, and notification settings. Replace 'authtoken' and 'scope' with your credentials. ```xml Conference 2009-08-04 01:00:00 2009-08-05 01:00:00 United States True ``` -------------------------------- ### Get Note Types API Source: https://help.zoho.com/portal/en/kb/recruit/developer-guide/api-methods/articles/getnotetypes This API endpoint allows you to retrieve a list of note types available in Zoho Recruit. It can be accessed using either OAuth or Authtoken authentication. ```APIDOC ## POST /recruit/private/json/Notes/getNoteTypes ### Description Retrieves a list of note types in Zoho Recruit. Although the documentation mentions GET, it's recommended to use the POST method for passing parameters. ### Method POST ### Endpoint `https://recruit.zoho.com/recruit/private/json/Notes/getNoteTypes` ### Parameters #### Query Parameters - **authtoken** (String) - Required - Encrypted alphanumeric string to authenticate your Zoho credentials. - **scope** (String) - Required - Specify the value as `recruitapi`. - **version** (Integer) - Required - The API version, typically `2`. #### Request Body This endpoint does not explicitly define a request body in the provided documentation. Parameters are expected as query parameters. ### Request Example ```json { "authtoken": "YOUR_AUTH_TOKEN", "scope": "recruitapi", "version": 2 } ``` ### Response #### Success Response (200) - **response** (Object) - The root object containing the result of the operation. - **uri** (String) - The URI of the request. - **result** (Object) - **Notes** (Array of Objects) - A list of note type objects. - **row** (Object) - **no** (Integer) - The row number. - **FL** (Array of Objects) - List of fields for the note type. - **val** (String) - The name of the field (e.g., "Note Type", "Note Id", "Is System"). - **CDATA** (String) - The value of the field. #### Response Example ```xml ``` ### Authentication This endpoint supports two types of authentication: #### Authtoken Authentication - **Parameter**: `authtoken` (String, Required) - **Parameter**: `scope` (String, Required) - Value should be `recruitapi`. #### OAuth Authentication - **Header**: `Authorization: Zoho-oauthtoken {access_token}` - **Scopes**: `ZohoRecruit.modules.call.all` or `ZohoRecruit.modules.{scope_name}.{operation_type}` ``` -------------------------------- ### POST /Candidates/uploadDocument Source: https://help.zoho.com/portal/en/kb/recruit/developer-guide/api-methods/articles/uploaddocument Use this API endpoint to parse and upload candidate resumes in Zoho Recruit from third-party applications. This functionality is available only in the Paid Edition. ```APIDOC ## POST /Candidates/uploadDocument ### Description This endpoint allows for the parsing and uploading of candidate resumes to Zoho Recruit from external applications. It is exclusively available in the Paid Edition of Zoho Recruit. ### Method POST ### Endpoint `https://recruit.zoho.com/recruit/private/json/Candidates/uploadDocument` ### Parameters #### Query Parameters - **authtoken** (String) - Required - An encrypted alphanumeric string to authenticate your Zoho credentials. - **scope** (String) - Required - Specify the value as `recruitapi`. - **version** (Integer) - Optional - The API version. - **country** (String) - Optional - The country code for the candidate. - **fileName** (String) - Optional - The name of the file containing the resume data. - **documentData** (String) - Optional - The base64 encoded resume data. #### Request Body This endpoint does not typically use a request body when parameters are passed via the URL. However, for `documentData`, it should be URL-encoded. ### Request Example ``` https://recruit.zoho.com/recruit/private/xml/Candidates/uploadDocument?authtoken=7d987658943g4j09h43dd0b167dda34b&scope=recruitapi&version=2&country=RU&fileName=johnCV.txt&documentData=TmFtZTogVG9ueQ0KDQpFbWFpbDogdG9ueUB6b2hvY29ycC5jb20NCg0KTG9jYXRpb246IENoZW5uYWk%3D ``` ### Response #### Success Response (200) - **message** (String) - Indicates the success of the operation (e.g., "Candidate added successfully"). - **recorddetail** (Object) - Contains details of the newly added record. - **Id** (String) - The unique identifier of the added candidate record. #### Response Example ```xml Candidate added successfully 292114000000373049 ``` **Note:** You can upload a maximum of 250 documents per day. ``` -------------------------------- ### Insert Multiple Records via Zoho Recruit API (XML) Source: https://help.zoho.com/portal/en/kb/recruit/developer-guide/api-methods/articles/addrecords This snippet demonstrates the XML structure required to insert multiple candidate records using the Zoho Recruit API's addRecords method. It includes the base URL format and an example of the XML data with multiple 'row' elements, each representing a candidate with 'Last Name' and 'Email' fields. Note the limitation of 100 records per request. ```xml testingtest1@test.com testingtest2@test.com testingtest3@test.com testingtest4@test.com testingtest5@test.com testingtest6@test.com testingtest7@test.com testingtest8@test.com testingtest9@test.com testingtest10@test.com : : : testingtest100@test.com ``` -------------------------------- ### Get Recruit Modules (JSON) Source: https://help.zoho.com/portal/en/kb/recruit/developer-guide/api-methods/articles/getmodules This code snippet shows how to retrieve a list of modules from a Zoho Recruit account using the getModules method in JSON format. It requires an authtoken and a scope parameter for authentication and specifying the API version. ```JSON https://recruit.zoho.com/recruit/private/json/Info/getModules?authtoken=AuthToken&scope=recruitapi ``` -------------------------------- ### Get Recruit Modules (XML) Source: https://help.zoho.com/portal/en/kb/recruit/developer-guide/api-methods/articles/getmodules This code snippet demonstrates how to request a list of modules from a Zoho Recruit account using the getModules method in XML format. It requires an authtoken and a scope parameter for authentication and specifying the API version. ```XML https://recruit.zoho.com/recruit/private/xml/Info/getModules?authtoken=AuthToken&scope=recruitapi ``` -------------------------------- ### Get Associated Job Openings - OAuth Authentication Header Source: https://help.zoho.com/portal/en/kb/recruit/developer-guide/api-methods/articles/getassociatedjobopenings This code snippet shows the required HTTP header for authenticating with the getAssociatedJobOpenings API using OAuth. The 'Authorization' header should contain 'Zoho-oauthtoken' followed by the access token. ```http Authorization: Zoho-oauthtoken {access_token} ``` -------------------------------- ### GET /recruit/private/xml/Notes/getRelatedRecords Source: https://help.zoho.com/portal/en/kb/recruit/developer-guide/api-methods/articles/getrelatedrecords Fetches notes associated with a specific record in Zoho Recruit. ```APIDOC ## GET /recruit/private/xml/Notes/getRelatedRecords ### Description This endpoint retrieves all notes that are linked to a particular record within Zoho Recruit. You need to provide the record's ID and its module name. ### Method GET ### Endpoint https://recruit.zoho.com/recruit/private/xml/Notes/getRelatedRecords ### Parameters #### Query Parameters - **authtoken** (string) - Required - Your authentication token for API access. - **scope** (string) - Required - The scope of the API request, typically 'recruitapi'. - **id** (string) - Required - The unique identifier of the record. - **parentModule** (string) - Required - The name of the module the record belongs to. ### Request Example ``` https://recruit.zoho.com/recruit/private/xml/Notes/getRelatedRecords?authtoken=&scope=recruitapi&id=RECORD_ID&parentModule=Module Name ``` ### Response #### Success Response (200) - **row** (array) - Contains details of each note. - **FL** (object) - Field details for each note. - **val** (string) - The name of the field (e.g., 'id', 'Title', 'Note Content'). - **text** (string) - The value of the field, often CDATA-escaped. #### Response Example ```xml 5080200000005483628 508020000000065849 508020000000065849 508020000000065849 ``` ``` -------------------------------- ### GET /Module/getFields Source: https://help.zoho.com/portal/en/kb/recruit/developer-guide/api-methods/articles/getfields Fetches details of the fields available in a particular Zoho Recruit module. ```APIDOC ## GET /Module/getFields ### Description This endpoint allows you to retrieve detailed information about the fields available within a specified module in Zoho Recruit. This is useful for understanding the data structure of modules like Candidates, JobOpenings, Clients, and custom modules. ### Method GET ### Endpoint `/Module/getFields` ### Parameters #### Query Parameters - **authtoken** (String) - Required - Encrypted alphanumeric string to authenticate your Zoho credentials. - **scope** (String) - Required - Specify the value as `recruitapi`. - **version** (Number) - Optional - API version (defaults to 2). #### Request Body This endpoint does not accept a request body. ### Request Example (JSON) ```json https://recruit.zoho.com/recruit/private/json/Candidates/getFields?authtoken=YourAuthToken&scope=recruitapi&version=2 ``` ### Request Example (XML) ```xml https://recruit.zoho.com/recruit/private/xml/Candidates/getFields?authtoken=YourAuthToken&scope=recruitapi&version=2 ``` ### Authentication #### For OAuth Authentication **Header Name** | **Value** ---|--- Authorization | Zoho-oauthtoken {access_token} **Scopes** - `Scope=ZohoRecruit.fields.all` - `Scope=ZohoRecruit.fields.{scope_name}.{operation_type}` **Possible Scope Names** | **Operation Types** ---|--- referral, campaign, assessment, vendor, event, task, candidate, jobopening, client, department, interview, contact & custom (for all Custom Modules ) | ALL - Full access to the record | READ - Get records from the module #### For Authtoken Authentication See Query Parameters section above. ### Response #### Success Response (200) - **fields** (Array) - An array of field objects, each containing details like field label, API name, data type, etc. #### Response Example (JSON) ```json { "fields": [ { "label": "Candidate Name", "api_name": "CandidateName", "data_type": "text" }, { "label": "Email", "api_name": "Email", "data_type": "email" } ] } ``` ```