Zoho Recruit API

https://www.zoho.com/recruit/developer-guide/apiv2/
Admin
Zoho Recruit API provides REST and bulk APIs for developers to integrate Zoho's recruiting platform...
Tokens:124,114
Snippets:1,336
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### URL Field

Source: https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html

Example of a URL string.

```json
"URL": "https://www.zylker.com"
```

--------------------------------

### Sample Response - Get Associated Job Openings

Source: https://www.zoho.com/recruit/developer-guide/apiv2/get-associated-records.html

Example JSON response structure returned when querying associated records.

```json
{
    "data": [
        {
            "Email": null,
            "$currency_symbol": "$",
            "Last_Activity_Time": "2019-12-18T11:01:15+05:30",
            "GDPR_Consent_Date": "2019-12-18",
            "Highest_Qualification_Held": null,
            "Skill_Set": null,
            "$converted": false,
            "$process_flow": false,
            "Updated_On": "2019-12-18T10:58:04+05:30",
            "Current_Employer": null,
            "Street": null,
            "Zip_Code": null,
            "id": "100001000000028010",
            "Experience_in_Years": null,
            "$approved": true,
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false,
                "resubmit": false
            },
            "GDPR_Consent_Status": "Opt-In not requested",
            "Candidate_Status": "Unqualified",
            "Candidate_ID": "ZR_3_CAND",
            "Last_Mailed_Time": null,
            "Created_Time": "2019-12-18T10:58:04+05:30",
            "$followed": false,
            "GDPR_Consent_Mode": null,
            "$editable": true,
            "Is_Locked": false,
            "City": null,
            "Candidate_Owner": {
                "name": "Patricia Boyle",
                "id": "100001000000020223"
            },
            "Is_Unqualified": false,
            "Associated_Tags": [],
            "Additional_Info": null,
            "State": null,
            "Country": null,
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "100001000000020223"
            },
            "Is_Attachment_Present": false,
            "CANDIDATEPORTALSTATUS": "0",
            "Rating": null,
            "Website": null,
            "Twitter": null,
            "Current_Job_Title": null,
            "Salutation": null,
            "Source": "Added by User",
            "First_Name": null,
            "Full_Name": "av",
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "100001000000020223"
            },
            "Skype_ID": null,
            "Experience_Details": [],
            "Phone": null,
            "Email_Opt_Out": false,
            "Educational_Details": [],
            "$converted_detail": {},
            "Mobile": null,
            "Last_Name": "av",
            "Current_Salary": null,
            "Associated_any_Social_Profiles": null,
            "Fax": null,
            "Expected_Salary": null
        },
        {
            "Email": null,
            "$currency_symbol": "$",
            "Last_Activity_Time": "2019-12-18T11:00:01+05:30",
            "GDPR_Consent_Date": "2019-12-18",
            "Highest_Qualification_Held": null,
            "Skill_Set": null,
            "$converted": false,
            "$process_flow": false,
            "Updated_On": "2019-12-18T10:55:54+05:30",
            "Current_Employer": null,
            "Street": null,
            "Zip_Code": null,
            "id": "100001000000028001",
            "Experience_in_Years": null,
            "$approved": true,
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false,
                "resubmit": false
            },
            "GDPR_Consent_Status": "Opt-In not requested",
            "Candidate_Status": "Qualified1",
            "Candidate_ID": "ZR_2_CAND"
```

--------------------------------

### Add Tags Response Example

Source: https://www.zoho.com/recruit/developer-guide/apiv2/add-tags.html

Example of a successful JSON response after adding tags to a record.

```json
{
    "data": [{
        "code": "SUCCESS",
        "details": {
            "id": 486812000001660091,
            "tags": [
                "Campaign"
            ]
        },
        "message": "tags updated successfully",
        "status": "success"
    }]
}
```

--------------------------------

### Get Tags Request

Source: https://www.zoho.com/recruit/developer-guide/apiv2/get-tag-list.html

Example cURL command to retrieve tags for the Candidates module.

```bash
curl "https://recruit.zoho.com/recruit/v2/settings/tags?module=Candidates"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

--------------------------------

### Fetch Records via cURL

Source: https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html

Example of a GET request to retrieve client records using an OAuth token.

```bash
curl "https://recruit.zoho.com/recruit/v2/Clients"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

--------------------------------

### Field Data Type Examples

Source: https://www.zoho.com/recruit/developer-guide/apiv2/insert-records.html

Examples of JSON key-value pairs for different field types supported by the API.

```json
"No_of_Employees": 350,
```

```json
"Annual_Revenue": 250000.90,
```

```json
"Decimal_1": 250000.50,
```

```json
"Percentage": 25,
```

```json
"EAN_Code":"0012345600012",
```

```json
"Email_Opt_Out": true,
```

```json
"URL": "https://www.zylker.com",
```

```json
"Lookup" : {
"name" : "James",
"id" : "425248000000104001"
},
```

```json
"Accounts":[
{
"Account_Name":"Zylker1",
"id":"4150868000000420069"
},
{
"Account_Name":"Zylker",
"id":"4150868000000420046"
}
]
```

```json
"User":
{
"name":"Patricia Boyle",
"id":"4150868000000623001"
}
```

--------------------------------

### Picklist Attribute

Source: https://www.zoho.com/recruit/developer-guide/apiv2/insert-records.html

Example of a picklist field input.

```JSON
"Industry": "automobile"
```

--------------------------------

### Add Tags Request Example

Source: https://www.zoho.com/recruit/developer-guide/apiv2/add-tags.html

Example of a cURL request to add tags to a candidate record.

```bash
curl "https://recruit.zoho.com/recruit/v2/Candidates/486812000001660091/actions/add_tags?tag_names=New" -
    X POST -
    H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
    --data - raw '{
"data": [{
    "name": "Campaign",
    "color_code": "#969696"
}]
}'
```

--------------------------------

### Email Field

Source: https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html

Example of a valid email string.

```json
"Email_1": "p.boyle@zylker.com"
```

--------------------------------

### Email Attribute

Source: https://www.zoho.com/recruit/developer-guide/apiv2/insert-records.html

Example of an email field input.

```JSON
"Email_1": "p.boyle@zylker.com",
```

--------------------------------

### GET /settings/roles

Source: https://www.zoho.com/recruit/developer-guide/apiv2/get-roles.html

Retrieves a list of all roles defined in the system.

```APIDOC
## GET https://recruit.zoho.com/recruit/v2/settings/roles

### Description
Retrieves the data of all roles configured in Zoho Recruit.

### Method
GET

### Endpoint
https://recruit.zoho.com/recruit/v2/settings/roles

### Response
#### Success Response (200)
- **roles** (array) - A list of role objects.

#### Response Example
{
    "roles": [
        {
            "display_label": "Recruiter Admin",
            "share_with_peers": true,
            "name": "Recruiter Admin",
            "id": "486812000000071953",
            "reporting_to": null
        }
    ]
}
```

--------------------------------

### Date/Time Attribute

Source: https://www.zoho.com/recruit/developer-guide/apiv2/insert-records.html

Example of a date/time field input in ISO 8601 format.

```JSON
"Date_Time": "2017-08-16T14:32:23+05:30",
```

--------------------------------

### GET /recruit/v2/{module_name}

Source: https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html

Retrieves a list of records from the specified module.

```APIDOC
## GET /recruit/v2/{module_name}

### Description
Fetches records from a specified module in Zoho Recruit.

### Method
GET

### Endpoint
https://recruit.zoho.com/recruit/v2/{module_name}

### Parameters
#### Path Parameters
- **module_name** (string) - Required - The name of the module to fetch records from (e.g., Clients).

### Request Example
curl "https://recruit.zoho.com/recruit/v2/Clients" \
-X GET \
-H "Authorization: Zoho-oauthtoken {token}"

### Response
#### Success Response (200)
- **data** (array) - List of records retrieved.
- **info** (object) - Metadata about the response, including pagination details.

#### Response Example
{
    "data": [{
        "id": "486812000001224088",
        "Client_Name": "Juice"
    }],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
```

--------------------------------

### Configure Separate Scopes

Source: https://www.zoho.com/recruit/developer-guide/apiv2/oauth-overview.html

Example URL for requesting access to specific modules only, such as candidates and job openings.

```text
https://accounts.zoho.com/oauth/v2/auth?scope=ZohoRecruit.modules.candidates.ALL,ZohoRecruit.modules.jobopenings.ALL,ZohoRecruit.settings.ALL&client_id={client_id}&response_type=code&access_type={"offline"or"online"}&redirect_uri={redirect_uri}
```

--------------------------------

### Get Related Records Request

Source: https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html

Example of a cURL request to retrieve attachments for a specific interview record.

```bash
curl "https://recruit.zoho.com/recruit/v2/Interviews/100001000000023096/Attachments"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

--------------------------------

### Sample POST Request

Source: https://www.zoho.com/recruit/developer-guide/apiv2/insert-records.html

A basic cURL command to initiate a POST request to the Candidates module.

```bash
curl "https://recruit.zoho.com/recruit/v2/Candidates"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X POST
```

--------------------------------

### Search Records by Criteria

Source: https://www.zoho.com/recruit/developer-guide/apiv2/search-records.html

Example of a GET request to search for candidates by last name using the criteria parameter.

```curl
curl "https://recruit.zoho.com/recruit/v2/Candidates/search?criteria=(Last_Name:contains:Jacky)"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

--------------------------------

### Sample Request - Candidate Submission

Source: https://www.zoho.com/recruit/developer-guide/apiv2/update-review.html

A JSON payload example for updating a candidate submission review.

```json
{
    "data": [
        {
            "Review_Comments": "Sample Comment",
            "id": "100002000000535255",
            "Rating": 3,
            "$status_info": {
                "Application_Status": "New",
                "lock": "false"
            }
        }
    ]
}
```

--------------------------------

### Configure Group Scopes

Source: https://www.zoho.com/recruit/developer-guide/apiv2/oauth-overview.html

Example URL for requesting access to all modules and settings within a Zoho Recruit account.

```text
https://accounts.zoho.com/oauth/v2/auth?scope=ZohoRecruit.modules.ALL,ZohoRecruit.settings.ALL&client_id={client_id}&response_type=code&access_type={"offline"or"online"}&redirect_uri={redirect_uri}
```

--------------------------------

### GET /settings/modules

Source: https://www.zoho.com/recruit/developer-guide/apiv2/modules-api.html

Retrieves the list of all modules available in the Zoho Recruit account.

```APIDOC
## GET /settings/modules

### Description
Retrieves the list of all modules available in your Zoho Recruit account.

### Method
GET

### Endpoint
https://recruit.zoho.com/recruit/v2/settings/modules

### Request Example
curl "https://recruit.zoho.com/recruit/v2/settings/modules" \
-X GET \
-H "Authorization: Zoho-oauthtoken {access_token}"

### Response
#### Success Response (200)
- **modules** (array) - List of module objects containing metadata like api_name, creatable, and generated_type.
```

--------------------------------

### Checkbox Field

Source: https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html

Example of a boolean checkbox value.

```json
"Email_Opt_Out": true
```

--------------------------------

### Percent Field

Source: https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html

Example of a percentage double value.

```json
"Percentage": 25
```

--------------------------------

### Decimal Field

Source: https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html

Example of a decimal double value.

```json
"Decimal_1": 250000.50
```

--------------------------------

### Currency Field

Source: https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html

Example of a currency double value.

```json
"Annual_Revenue": 250000.90
```

--------------------------------

### Modules API Response Structure

Source: https://www.zoho.com/recruit/developer-guide/apiv2/modules-api.html

Example JSON response showing the metadata structure for modules, including attributes like api_name, generated_type, and profile permissions.

```json
{
   "modules": [ 
       { 
           "global_search_supported": false, 
           "deletable": false, 
           "creatable": false, 
           "modified_time": null, 
           "plural_label": "Home", 
           "presence_sub_menu": false, 
           "id": "100001000000002511", 
           "convertable": false, 
           "editable": false, 
           "emailTemplate_support": false, 
           "profiles": [ 
               { 
                   "name": "Administrator", 
                   "id": "100001000000017723" 
               }, 
               { 
                   "name": "Standard", 
                   "id": "100001000000017726" 
               }, 
               { 
                   "name": "Guest", 
                   "id": "100001000000017729" 
               }, 
               { 
                   "name": "Interviewer", 
                   "id": "100001000000017732" 
               }, 
               { 
                   "name": "Client Administrator", 
                   "id": "100001000000021138" 
               }, 
               { 
                   "name": "Client Interviewer", 
                   "id": "100001000000021459" 
               } 
           ], 
           "filter_supported": false, 
           "display_field": null, 
           "web_link": null, 
           "sequence_number": 1, 
           "singular_label": "Home", 
           "viewable": true, 
           "api_supported": false, 
           "api_name": "Home", 
           "quick_create": false, 
           "modified_by": null, 
           "generated_type": "default", 
           "scoring_supported": false, 
           "module_name": "Home", 
           "parent_module": {} 
       }, 
       { 
           "global_search_supported": true, 
           "deletable": true, 
           "creatable": true, 
           "modified_time": null, 
           "plural_label": "Job Openings", 
           "presence_sub_menu": true, 
           "id": "100001000000002521", 
           "convertable": false, 
           "editable": true, 
           "emailTemplate_support": true, 
           "profiles": [ 
               { 
                   "name": "Administrator", 
                   "id": "100001000000017723" 
               }
```

--------------------------------

### Number Field

Source: https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html

Example of an integer number field.

```json
"No_of_Employees": 350
```

--------------------------------

### Phone Field

Source: https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html

Example of a numeric phone string.

```json
"Phone_1": "9900000000"
```

--------------------------------

### Create Bulk Write Job Request

Source: https://www.zoho.com/recruit/developer-guide/apiv2/bulk-write/create-job.html

Use this cURL command to initiate a bulk write job by pointing to a local JSON file containing the operation details.

```bash
curl "https://recruit.zoho.com/recruit/bulk/v2/write"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@inputData.json"
```

--------------------------------

### Phone Attribute

Source: https://www.zoho.com/recruit/developer-guide/apiv2/insert-records.html

Example of a phone field input.

```JSON
"Phone_1": "9900000000",
```

--------------------------------

### POST https://recruit.zoho.com/recruit/v2/Candidates/actions/import_document

Source: https://www.zoho.com/recruit/developer-guide/apiv2/upload-document.html

Imports a resume document to the parser.

```APIDOC
## POST https://recruit.zoho.com/recruit/v2/Candidates/actions/import_document

### Description
To import resumes individually to the parser. You need to provide both base64 data and the file name as parameters.

### Method
POST

### Endpoint
https://recruit.zoho.com/recruit/v2/Candidates/actions/import_document

### Parameters
#### Request Body
- **filename** (String) - Required - Specify the file name and format
- **document** (base64/FileInputStream) - Required - Provide base64 encoded resume or file stream

### Request Example
curl "https://recruit.zoho.com/recruit/Candidates/actions/import_document" -X POST -H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

--------------------------------

### Define Scope for API Authorization

Source: https://www.zoho.com/recruit/developer-guide/apiv2/oauth-overview.html

Example URL format for defining a scope using service name, scope name, and operation type.

```text
https://accounts.zoho.com/oauth/v2/auth?scope=ZohoRecruit.modules.ALL
```

--------------------------------

### Lookup Field

Source: https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html

Example of a lookup field as a JSON object.

```json
"Lookup" : {  
"name" : "James",  
"id" : "425248000000104001"  
}
```
Tokens:
Raw