Zoho Recruit API Integration

These are the list of integration use cases supported by Knit for Zoho Recruit API as part of the ATS category

Upload an Attachment to a Application

ID: add_attachment_to_application
Operation: write
Entities:
Summary: This API allows you to attach a file to a specific record in Zoho Recruit. The request must include the file as multipart/form-data and requires an OAuth token for authentication. The URL includes path parameters for the module API name and record ID. Query parameters include mandatory fields for attachment category ID and label, and an optional attachment URL. The file size limit is 20MB, and all file types except .exe are supported. The response includes a success or failure code, a message, and additional details such as the attachment ID.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Tag

ID: delete_a_tag
Operation: write
Entities: settings, tag, module
Summary: The 'Delete a Tag' API allows users to delete a specific tag from a module in Zoho Recruit. The request requires the unique ID of the tag to be deleted, which is specified as a path parameter. The request must include an Authorization header with a valid OAuth token. The API supports various modules such as candidate, jobopening, submission, offers, interview, client, contact, department, vendors, application, and custommodule. The response returns a success message with the ID of the deleted tag if the operation is successful.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Attachment

ID: delete_an_attachment
Operation: write
Entities: record, module, attachment
Summary: The 'Delete an Attachment' API is used to delete a file attached to a record in Zoho Recruit. The request requires the module API name, record ID, and attachment ID as path parameters. The request method is DELETE, and it requires an Authorization header with a valid OAuth token. The response returns a success message with the ID of the deleted attachment.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Entities or Records from a Module

ID: delete_entities_or_records_from_a_module
Operation: write
Entities: entity, module, record
Summary: This API is used to delete entities or records from a specified module in Zoho Recruit. The API requires the module's API name and the unique IDs of the records to be deleted. The 'ids' parameter is mandatory and can accept multiple record IDs separated by commas. An optional 'wf_trigger' parameter can be used to specify whether workflow rules should be triggered upon deletion. The API supports deleting up to 100 records per call. The response includes the status of the deletion operation for each record.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Note Type in Zoho Recruit

ID: delete_note_type_in_zoho_recruit
Operation: write
Entities: user, module, note
Summary: The Delete Note Type API in Zoho Recruit allows users to delete an existing note type by specifying the note ID in the URL path or multiple note IDs as query parameters. The API requires an OAuth token for authentication. The response includes the status of the deletion operation for each note ID specified. Possible errors include invalid module names, incorrect URL patterns, insufficient permissions, and missing required parameters.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Photo from a Record in a Module

ID: delete_photo_from_record
Operation: write
Entities: photo, module, record
Summary: This API deletes a photo from a record in a specified module in Zoho Recruit. The request requires the module's API name and the unique record ID as path parameters. The request must include an Authorization header with a valid OAuth token. Supported modules are Candidates and Contacts. The response indicates the success of the operation with a message and status.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Tags in an Organization

ID: get_all_tags_in_an_organization
Operation: read
Entities:
Summary: This API retrieves all the tags in an organization for a specified module. The request requires an OAuth token for authentication and the module API name as a mandatory query parameter. Optionally, you can specify 'my_tags' to display tags created by the current user. The response includes details about each tag, such as its color code, creation and modification times, and the users who created and modified the tags.
Input Fields: Input Fields
Output Fields: Output Fields

Get Application Status by Application ID

ID: get_application_status_by_application_id
Operation: read
Entities: stage
Summary: This API will get the current stage of application for given application ID. It is also referred as application status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Applications

ID: get_applications
Operation: read
Entities: job_opening, recruiter, application
Summary: The Get Applications API retrieves a list of application records from Zoho Recruit. It supports various query parameters to filter and sort the records, such as 'fields', 'sort_order', 'sort_by', 'converted', 'approved', 'page', 'per_page', 'cvid', 'territory_id', 'include_child', and '$state'. The API requires an Authorization header with a Zoho OAuth token. The response includes detailed information about each application, such as the origin, client name, application status, email, candidate ID, posting title, assigned recruiters, and more. The response also provides pagination information, including the number of records per page, the current page, and whether more records are available.
Input Fields: Input Fields
Output Fields: Output Fields

Get Associated Records

ID: get_associated_records
Operation: read
Entities: record, jobopening, candidate
Summary: The Get Associated Records API retrieves a list of associated records for a specific record ID within a module. The API requires the module API name and record ID as path parameters. It supports optional query parameters such as posting_title, candidate_statuses, page, and per_page to filter and paginate the results. The response includes a list of associated records with their IDs and names, along with pagination information. The API requires a valid scope in the headers to define the access level.
Input Fields: Input Fields
Output Fields: Output Fields

Get Associated Records of Candidates

ID: get_associated_records_of_candidates
Operation: read
Entities: candidate, job, application
Summary: The 'Get Associated Records of Candidates' API retrieves associated records for a specific candidate in the Zoho Recruit system. The API requires the candidate's unique ID as a path parameter and supports optional query parameters such as 'posting_title', 'candidate_statuses', 'page', and 'per_page' to filter and paginate the results. The request must include an 'Authorization' header with a valid Zoho OAuth token. The response includes detailed information about associated job openings, recruiters, and other relevant data, structured in a JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Associated Records of Job Openings

ID: get_associated_records_of_job_openings
Operation: read
Entities: JobOpening, Account, Candidate
Summary: The 'Get Associated Records of Job Openings' API retrieves associated records for a specific job opening in Zoho Recruit. The API requires an OAuth token for authentication and the JobOpeningID as a path parameter. Optional query parameters include 'posting_title' to filter job openings by title, 'candidate_statuses' to filter candidates by status, 'page' to specify the page number, and 'per_page' to specify the number of records per page. The response includes detailed information about each associated record, such as account manager details, industry, job description, and more. The API is useful for obtaining comprehensive details about job openings and their associated records.
Input Fields: Input Fields
Output Fields: Output Fields

Get attachments related to an application

ID: get_attachment_for_given application ID
Operation: read
Entities: attachment
Summary: The 'Get related records for applications' API allows users to retrieve attachments related to a specific application in the Zoho Recruit system. The API requires the application's ID as a path parameter and supports various optional query parameters such as 'ids' for specific related record IDs, 'sort_order' and 'sort_by' for sorting, 'page' and 'per_page' for pagination, and 'fields' for specifying which fields to include in the response. The response includes detailed information about each attachment, such as its type, modification time, category, file name, size, and ownership details. The API also provides pagination information in the 'info' object. Authentication is required via an OAuth token in the request headers.
Input Fields: [Input Fields](https://frontend-service.getknit.dev/atom/details?appId=zoho-recruit&atomId=get_attachment_for_given application ID&data=input)
Output Fields: [Output Fields](https://frontend-service.getknit.dev/atom/details?appId=zoho-recruit&atomId=get_attachment_for_given application ID&data=output)

Get Bulk Read Job Details

ID: get_bulk_read_job_details
Operation: read
Entities: user, module, bulk_read_job
Summary: The 'Get Bulk Read Job Details' API retrieves the details of a previously performed bulk read job in Zoho Recruit. The API requires the unique job ID as a path parameter and an OAuth token for authentication in the headers. The response includes details such as the operation type, the user who initiated the job, the creation time, the current state of the job, and the query used. If the job is completed, the result object provides additional information like the page number, count of records, download URL, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Get Bulk Write Job Details

ID: get_bulk_write_job_details
Operation: read
Entities: user, file, bulk_write_job
Summary: The 'Get Bulk Write Job Details' API retrieves the details of a previously performed bulk write job in Zoho Recruit. The API requires the unique job ID as a path parameter and an OAuth token for authentication in the headers. The response includes the status of the job, character encoding, resource details such as module, field mappings, and file status, as well as information about the user who initiated the job, the operation type, and the creation time. The response also provides a download URL for the result if the job is completed.
Input Fields: Input Fields
Output Fields: Output Fields

Get Campaigns

ID: get_campaigns
Operation: read
Entities: campaign
Summary: The Get Campaigns API allows users to retrieve a list of campaign records from Zoho Recruit. It supports various query parameters to filter and sort the records, such as fields, sort_order, sort_by, converted, approved, page, per_page, cvid, territory_id, include_child, and $state. The API requires an Authorization header with a Zoho OAuth token. The response includes a list of campaign records with various attributes like Single_Line_1, Multi_Line_1, Email_1, Phone_1, and more. The API also supports pagination through the page and per_page parameters.
Input Fields: Input Fields
Output Fields: Output Fields

Get Candidates

ID: get_candidates
Operation: read
Entities: user, candidate, territory
Summary: The Get Candidates API allows users to retrieve a list of candidate records from Zoho Recruit. The API endpoint is 'https://recruit.zoho.in/recruit/v2/Candidates' and it uses the GET method. Users must provide an 'Authorization' header with a valid Zoho OAuth token. Optional query parameters include 'fields', 'sort_order', 'sort_by', 'converted', 'approved', 'page', 'per_page', 'cvid', 'territory_id', 'include_child', and '$state' to filter and sort the records. The response includes a list of candidate records with detailed information such as email, status, owner, and more, along with pagination info. The API supports filtering by various criteria and sorting by specified fields.
Input Fields: Input Fields
Output Fields: Output Fields

Get Clients

ID: get_clients
Operation: read
Entities: Account Manager, Client, Tag
Summary: The Get Clients API retrieves a list of client records from Zoho Recruit. It supports various query parameters to filter and sort the records, such as fields, sort_order, sort_by, converted, approved, page, per_page, cvid, territory_id, include_child, and $state. The API requires an Authorization header with a Zoho OAuth token and session cookies for authentication. The response includes detailed information about each client, such as Client_Name, Account Manager, Modified_By, and more, along with pagination info. The API also handles errors related to invalid modules and permissions.
Input Fields: Input Fields
Output Fields: Output Fields

Fetch Comprehensive Details of a Specific Job Opening

ID: get_comprehensive_job_opening_details
Operation: read
Entities:
Summary: The Fetch Comprehensive Details of a Specific Job Opening API retrieves detailed information about a specific job opening from Zoho Recruit using the job opening ID as a path parameter. It requires an Authorization header with a Zoho OAuth token. The API supports various query parameters to filter and sort the results, such as fields, sort_order, sort_by, converted, approved, page, per_page, cvid, territory_id, include_child, and $state. The response includes comprehensive details about the job opening, such as client name, posting title, account manager, required skills, job type, and more. The API also provides pagination support through the page and per_page parameters.
Input Fields: Input Fields
Output Fields: Output Fields

Get Contacts

ID: get_contacts
Operation: read
Entities: contact, client, record
Summary: The Get Contacts API retrieves a list of contact records from the Zoho Recruit module. It supports various query parameters to filter and sort the records, such as fields, sort_order, sort_by, converted, approved, page, per_page, cvid, territory_id, include_child, and $state. The API requires an Authorization header with a Zoho OAuth token and session cookies for authentication. The response includes detailed information about each contact, such as their origin, client name, email, and other attributes, along with pagination info. The API is useful for fetching contact data with specific criteria and supports admin-level access for certain modules.
Input Fields: Input Fields
Output Fields: Output Fields

Custom View Metadata for Candidates

ID: get_custom_view_metadata_candidates
Operation: read
Entities: custom_view, module, candidate
Summary: This API retrieves the custom view metadata for a specified module in Zoho Recruit. The request requires an OAuth token for authentication and the module name as a query parameter. The response includes a list of custom views with details such as display value, system name, and whether the view is default or system-defined. The response also provides pagination information and translations for view categories. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Custom view Metadata Clients

ID: get_custom_view_metadata_clients
Operation: read
Entities: custom_view, client, module
Summary: The 'Custom view Metadata Clients' API retrieves the custom views data for a specified module in Zoho Recruit. The API requires the module name as a query parameter, which is mandatory. The response includes a list of custom views with details such as display value, system name, default status, and more. The API also provides pagination information and translations for view categories. The API requires an OAuth token for authentication and supports scopes for reading custom views settings.
Input Fields: Input Fields
Output Fields: Output Fields

Custom view Metadata Contacts

ID: get_custom_view_metadata_contacts
Operation: read
Entities: custom_view, contact, module
Summary: The 'Custom view Metadata Contacts' API retrieves the custom views data for the Contacts module in Zoho Recruit. The API requires an OAuth token for authentication and the module name as a query parameter. The response includes a list of custom views with details such as display value, system name, and whether the view is default or system-defined. It also provides pagination information and translations for view categories. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Custom view Metadata Departments

ID: get_custom_view_metadata_departments
Operation: read
Entities: custom_view, module, department
Summary: The 'Custom view Metadata Departments' API retrieves custom view data for a specified module, in this case, 'Departments'. The API requires an OAuth token for authentication and accepts a mandatory query parameter 'module' to specify the module name. The response includes a list of custom views with details such as display value, system name, and whether the view is default or offline. Additional information about the views, such as the number of records per page and translation details, is also provided. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Custom view Metadata Events

ID: get_custom_view_metadata_events
Operation: read
Entities: custom_view, module, event
Summary: The 'Custom view Metadata Events' API retrieves the custom views data of a specified module in Zoho Recruit. The API requires the module name as a mandatory query parameter to specify which module's custom view data is to be retrieved. The request must include an Authorization header with a valid Zoho OAuth token. The response includes a list of custom views with details such as display value, system name, offline availability, default status, and more. Additionally, the response provides pagination information and translations for view categories. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Custom View Metadata for Interviews

ID: get_custom_view_metadata_interviews
Operation: read
Entities: custom_view, info, module
Summary: This API retrieves the custom view metadata for the 'Interviews' module in Zoho Recruit. The request requires an OAuth token for authentication and the module name as a query parameter. The response includes a list of custom views with details such as display value, system name, and whether the view is default or offline. It also provides pagination information and translations for view categories. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Custom view Metadata JobOpenings

ID: get_custom_view_metadata_jobopenings
Operation: read
Entities: custom_view, job_opening, module
Summary: The 'Custom view Metadata JobOpenings' API retrieves custom view data for the specified module, in this case, 'JobOpenings'. The API requires an OAuth token for authentication and the module name as a query parameter. The response includes a list of custom views with details such as display value, system name, and whether the view is default or offline. It also provides pagination information and translations for view categories. The API supports scopes for reading or full access to custom views.
Input Fields: Input Fields
Output Fields: Output Fields

Custom View Metadata Reviews

ID: get_custom_view_metadata_reviews
Operation: read
Entities: custom_view, review, module
Summary: The Custom View Metadata Reviews API retrieves the custom views data for a specified module in Zoho Recruit. The API requires the module name as a mandatory query parameter to specify which module's custom view data is to be retrieved. The response includes a list of custom views with details such as display value, system name, offline availability, default status, and more. The API also provides pagination information and translations for view categories. The API requires an OAuth token for authentication and supports scopes for reading custom views.
Input Fields: Input Fields
Output Fields: Output Fields

Custom View Metadata Submissions

ID: get_custom_view_metadata_submissions
Operation: read
Entities: custom_view, submission, module
Summary: The Custom View Metadata Submissions API retrieves the custom views data for a specified module in Zoho Recruit. The API requires the module name as a mandatory query parameter to specify which module's custom view data is to be retrieved. The request must include an Authorization header with a valid Zoho OAuth token. The response includes a list of custom views with details such as display value, system name, offline availability, default status, and more. It also provides pagination information and translations for view categories. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Custom View Metadata Tasks

ID: get_custom_view_metadata_tasks
Operation: read
Entities: custom_view, task, module
Summary: The Custom View Metadata Tasks API retrieves the custom views data for a specified module, in this case, 'Tasks'. The API requires an OAuth token for authentication and the module name as a query parameter. The response includes a list of custom views with details such as display value, system name, offline availability, and more. It also provides pagination information and translations for view categories. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Custom view Metadata Vendors

ID: get_custom_view_metadata_vendors
Operation: read
Entities: custom_view, vendor, module
Summary: The 'Custom view Metadata Vendors' API retrieves the custom views data for the 'Vendors' module in Zoho Recruit. The API requires the module name as a mandatory query parameter. It returns a list of custom views with details such as display value, system name, offline availability, default status, and more. The response also includes pagination information and translations for view categories. The API requires an OAuth token for authentication and supports scopes for reading custom views settings.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Custom Views Meta Data for a Module

ID: get_custom_views_meta_data_for_a_module
Operation: read
Entities: custom_view, module
Summary: This API retrieves the custom views data for a specified module in Zoho Recruit. The request requires the module's API name as a query parameter and an OAuth token for authentication in the headers. The response includes details about each custom view, such as its display name, criteria, sorting options, and fields included. The API supports modules like candidate, jobopenings, interview, client, contact, and more. It returns an error if the module name is invalid or unsupported.
Input Fields: Input Fields
Output Fields: Output Fields

Get Departments

ID: get_departments
Operation: read
Entities: account, client, department
Summary: The Get Departments API retrieves a list of department records from Zoho Recruit. It supports various query parameters to filter and sort the records, such as 'fields', 'sort_order', 'sort_by', 'converted', 'approved', 'page', 'per_page', 'cvid', 'territory_id', 'include_child', and '$state'. The API requires an Authorization header with a Zoho OAuth token. The response includes detailed information about each department, such as client name, account manager, modified time, and approval status, along with pagination info.
Input Fields: Input Fields
Output Fields: Output Fields

Download an Attachment

ID: get_download_an_attachment
Operation: read
Entities: record, module, attachment
Summary: This API endpoint allows you to download a file attached to a record in Zoho Recruit. You need to provide the module API name, record ID, and attachment ID as path parameters. The request must include an Authorization header with a valid OAuth token. The response will include the binary content of the attachment file along with headers indicating the content type and disposition.
Input Fields: Input Fields
Output Fields: Output Fields

Download Bulk Read Result

ID: get_download_bulk_read_result
Operation: read
Entities: module, bulk_read_job
Summary: The 'Download Bulk Read Result' API allows users to download the result of a bulk read job from Zoho Recruit as a CSV or ICS file. The file is returned in a .zip format, which needs to be extracted to access the CSV or ICS file. The API requires the 'job_id' as a path parameter to identify the bulk read job. The request must include an 'Authorization' header with a valid Zoho OAuth token. The response includes a zip file containing the requested data. The API supports exporting up to 200,000 records in CSV format and 20,000 records in ICS format per call. The 'fields' attribute can be specified for CSV exports to include specific fields, but it is not supported for ICS exports. The API enforces a rate limit of 10 requests per minute.
Input Fields: Input Fields
Output Fields: Output Fields

Download Photo Associated with a Module

ID: get_download_photo_associated_with_module
Operation: read
Entities: photo, module, record
Summary: This API endpoint allows you to download a photo associated with a specific module in Zoho Recruit. The request requires the module's API name and the unique record ID as path parameters. The request must include an Authorization header with a valid OAuth token. The response returns the photo in binary format, with the content type indicating the image format. Supported modules include Candidates and Contacts.
Input Fields: Input Fields
Output Fields: Output Fields

Get Events

ID: get_events
Operation: read
Entities: module, participant, event
Summary: The Get Events API retrieves a list of event records from the Zoho Recruit module. It supports various query parameters to filter and sort the records, such as 'fields', 'sort_order', 'sort_by', 'converted', 'approved', 'page', 'per_page', 'cvid', 'territory_id', 'include_child', and '$state'. The API requires an Authorization header with a Zoho OAuth token. The response includes detailed information about each event, such as 'All_day', 'Description', 'Start_DateTime', 'End_DateTime', 'Event_Title', 'Venue', and more, along with pagination information in the 'info' object. The API also handles errors related to invalid modules and permissions.
Input Fields: Input Fields
Output Fields: Output Fields

Get Field Metadata for Specified Module

ID: get_field_metadata_for_specified_module
Operation: read
Entities: module, layout, field
Summary: This API retrieves the field metadata for a specified module in Zoho Recruit. The fields displayed are from all layouts for the module, excluding layout-specific fields like mandatory fields or picklist values. The API requires an OAuth token for authorization and a mandatory query parameter 'module' to specify the API name of the required module. The response includes details such as field label, data type, visibility, and picklist values, among others.
Input Fields: Input Fields
Output Fields: Output Fields

Fields Metadata Applications

ID: get_fields_metadata_applications
Operation: read
Entities:
Summary: The 'Fields Metadata Applications' API retrieves metadata for fields in the specified module, such as 'Application'. It provides details about each field, including whether it is mandatory, its data type, length, and any picklist values if applicable. The API requires an OAuth token for authorization and the module name as a query parameter. The response includes metadata for all fields in the module, excluding layout-specific fields like mandatory fields or picklist values.
Input Fields: Input Fields
Output Fields: Output Fields

Fields Metadata Candidates

ID: get_fields_metadata_candidates
Operation: read
Entities: module, layout, field
Summary: The 'Fields Metadata Candidates' API retrieves metadata for fields in the specified module, such as 'Candidates'. It provides details about each field, including whether it is mandatory, its data type, length, and any picklist values if applicable. The API requires an OAuth token for authorization and the module name as a query parameter. The response includes metadata for all fields in the module, excluding layout-specific fields like mandatory fields or picklist values.
Input Fields: Input Fields
Output Fields: Output Fields

Fields Metadata Clients

ID: get_fields_metadata_clients
Operation: read
Entities: client, module, field
Summary: The 'Fields Metadata Clients' API retrieves metadata for fields in the 'Clients' module of Zoho Recruit. It provides details about each field, such as whether it is mandatory, its data type, length, visibility, and more. The API requires an OAuth token for authorization and the module name as a query parameter. The response includes a list of fields with attributes like 'system_mandatory', 'webhook', 'json_type', 'field_label', 'display_label', 'id', 'data_type', 'api_name', 'length', 'visible', 'view_type', and 'pick_list_values'. This API is useful for understanding the structure and constraints of fields in the 'Clients' module.
Input Fields: Input Fields
Output Fields: Output Fields

Fields Metadata Contacts

ID: get_fields_metadata_contacts
Operation: read
Entities: module, layout, field
Summary: The 'Fields Metadata Contacts' API retrieves metadata for fields in the specified module, such as 'Contacts'. It provides details about each field, including whether it is mandatory, its data type, and any picklist values. The API requires an OAuth token for authentication and the module name as a query parameter. The response includes a list of fields with their properties, such as system_mandatory, webhook support, json_type, field_label, display_label, id, data_type, api_name, and pick_list_values if applicable.
Input Fields: Input Fields
Output Fields: Output Fields

Fields Metadata Departments

ID: get_fields_metadata_departments
Operation: read
Entities: department, field
Summary: The 'Fields Metadata Departments' API retrieves metadata for fields in the specified module 'Departments'. It provides details about each field such as whether it is mandatory, its data type, length, visibility, and other attributes. The API requires an OAuth token for authorization and the module name as a query parameter. The response includes a list of fields with their properties, which can be used to understand the structure and constraints of the fields in the module.
Input Fields: Input Fields
Output Fields: Output Fields

Fields Metadata Events

ID: get_fields_metadata_events
Operation: read
Entities: module, layout, field
Summary: The 'Fields Metadata Events' API retrieves metadata for fields in the specified module 'Events' in Zoho Recruit. It provides details about each field such as whether it is mandatory, its data type, display label, and API name. The API requires an OAuth token for authentication and the module name as a query parameter. The response includes metadata for all fields in the module, including their picklist values if applicable.
Input Fields: Input Fields
Output Fields: Output Fields

Fields Metadata Interviews

ID: get_fields_metadata_interviews
Operation: read
Entities: interview, module, field
Summary: The Fields Metadata Interviews API retrieves metadata for fields in the 'Interviews' module of Zoho Recruit. It provides details about each field, such as whether it is mandatory, its data type, and any associated picklist values. The API requires an OAuth token for authorization and the module name as a query parameter. The response includes metadata for all fields in the specified module, excluding layout-specific fields.
Input Fields: Input Fields
Output Fields: Output Fields

Fields Metadata JobOpenings

ID: get_fields_metadata_jobopenings
Operation: read
Entities: JobOpening, Module, Field
Summary: The 'Fields Metadata JobOpenings' API retrieves metadata for fields in the 'Job Openings' module of Zoho Recruit. It provides details about each field, such as whether it is mandatory, its data type, visibility, and other attributes. The API requires an OAuth token for authentication and the module name as a query parameter. The response includes metadata for all fields in the specified module, excluding layout-specific fields like mandatory fields or picklist values. This API is useful for understanding the structure and properties of fields within the 'Job Openings' module.
Input Fields: Input Fields
Output Fields: Output Fields

Fields Metadata Reviews

ID: get_fields_metadata_reviews
Operation: read
Entities: review, module, field
Summary: The 'Fields Metadata Reviews' API retrieves metadata for fields in the specified module, 'Reviews'. It provides details about each field, such as whether it is mandatory, its data type, visibility, and other attributes. The API requires an OAuth token for authentication and a mandatory query parameter 'module' to specify the module name. The response includes a list of fields with their metadata, which can be used to understand the structure and constraints of the fields in the 'Reviews' module.
Input Fields: Input Fields
Output Fields: Output Fields

Fields Metadata Submissions

ID: get_fields_metadata_submissions
Operation: read
Entities: submission, module, field
Summary: The Fields Metadata Submissions API retrieves metadata for fields in the specified module, 'Submissions'. It provides details about each field, such as whether it is mandatory, its data type, length, visibility, and more. The API requires an OAuth token for authentication and the module name as a query parameter. The response includes metadata for all fields in the module, excluding layout-specific fields like mandatory fields or picklist values. This API is useful for understanding the structure and properties of fields within a module, aiding in integration and data management tasks.
Input Fields: Input Fields
Output Fields: Output Fields

Fields Metadata Tasks

ID: get_fields_metadata_tasks
Operation: read
Entities: module, layout, field
Summary: The Fields Metadata Tasks API retrieves metadata for fields in the specified module 'Tasks'. It provides details such as field labels, data types, visibility, and other attributes for each field. The API requires an OAuth token for authentication and a mandatory query parameter 'module' to specify the module name. The response includes metadata for all fields in the module, excluding layout-specific fields like mandatory fields or picklist values.
Input Fields: Input Fields
Output Fields: Output Fields

Fields Metadata Vendors

ID: get_fields_metadata_vendors
Operation: read
Entities: vendor, module, field
Summary: The 'Fields Metadata Vendors' API retrieves metadata for fields in the 'Vendors' module of Zoho Recruit. It provides details about each field, such as whether it is mandatory, its data type, length, visibility, and other attributes. The API requires an OAuth token for authentication and the module name as a query parameter. The response includes a list of fields with their metadata, which can be used to understand the structure and constraints of the 'Vendors' module fields.
Input Fields: Input Fields
Output Fields: Output Fields

Get Interviews

ID: get_interviews
Operation: read
Entities: job_opening, candidate, interview
Summary: The 'Get Interviews' API retrieves a list of interview records from Zoho Recruit. It requires an OAuth token for authorization and supports various query parameters to filter and sort the results, such as 'fields', 'sort_order', 'sort_by', 'converted', 'approved', 'page', 'per_page', 'cvid', 'territory_id', 'include_child', and '$state'. The response includes detailed information about each interview, such as client name, posting title, start and end times, interview duration, candidate name, interview owner, and more. The API also provides pagination support through 'page' and 'per_page' parameters. The response includes metadata about the number of records per page, total count, current page, and whether more records are available.
Input Fields: Input Fields
Output Fields: Output Fields

Get Job Openings

ID: get_job_openings
Operation: read
Entities: AssignedRecruiter, JobOpening, ClientName
Summary: The Get Job Openings API retrieves a list of job openings from Zoho Recruit. It supports various query parameters to filter and sort the results, such as fields, sort_order, sort_by, converted, approved, page, per_page, cvid, territory_id, include_child, and $state. The API requires an Authorization header with a Zoho OAuth token. The response includes detailed information about each job opening, such as client name, posting title, account manager, required skills, job type, and more. The API also provides pagination support through the page and per_page parameters.
Input Fields: Input Fields
Output Fields: Output Fields

Get List of Attachments

ID: get_list_of_attachments
Operation: read
Entities: candidate, attachment, application
Summary: The Get List of Attachments API allows users to retrieve a list of attachments associated with a specific record in various modules such as Candidates, Applications, Job Openings, and more. The API requires the module API name and the record ID as path parameters, and an OAuth token for authentication in the headers. The response includes details about each attachment, such as the ID, file name, size, and timestamps for creation and modification.
Input Fields: Input Fields
Output Fields: Output Fields

Get list of deleted Applications

ID: get_list_of_deleted_applications
Operation: read
Entities: user, application
Summary: The 'Get list of deleted Applications' API retrieves a list of applications that have been deleted from the Zoho Recruit system. The API requires an OAuth token for authentication and supports optional headers and query parameters to filter the results. The 'module' parameter is mandatory and specifies the module API name. The 'type' parameter can be used to specify the type of deleted records to retrieve, such as 'All', 'Recycle', or 'Permanent'. Pagination is supported through the 'page' and 'per_page' parameters. The response includes details about each deleted application, such as who deleted it, when it was deleted, and its display name. The response also includes pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

Get list of deleted Campaigns

ID: get_list_of_deleted_campaigns
Operation: read
Entities: Campaign
Summary: The 'Get list of deleted Campaigns' API retrieves a list of campaigns that have been deleted from the Zoho Recruit system. The API requires an OAuth token for authentication and supports optional headers and query parameters to filter the results. The 'module' parameter is mandatory and specifies the module API name. The 'type' parameter can be used to specify the type of deleted records to retrieve, such as 'All', 'Recycle', or 'Permanent'. Pagination is supported through the 'page' and 'per_page' parameters. The response includes details about each deleted campaign, such as who deleted it, when it was deleted, and its display name. The response also includes pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

Get list of deleted Candidates

ID: get_list_of_deleted_candidates
Operation: read
Entities: user, deleted_record, candidate
Summary: The 'Get list of deleted Candidates' API retrieves a list of candidates that have been deleted from the Zoho Recruit system. The API requires an OAuth token for authentication and supports optional headers and query parameters to filter the results. The 'If-Modified-Since' header can be used to fetch recently deleted records. The 'module' parameter is mandatory and specifies the module API name. The 'type' parameter can filter the results by deletion type (All, Recycle, Permanent). Pagination is supported through 'page' and 'per_page' parameters. The response includes details about each deleted candidate, such as who deleted them, their display name, and the deletion time, along with pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

Get list of deleted Clients

ID: get_list_of_deleted_clients
Operation: read
Entities: client
Summary: The 'Get list of deleted Clients' API retrieves a list of clients that have been deleted from the Zoho Recruit system. The API requires an OAuth token for authentication and supports optional headers and query parameters to filter the results. The 'module' parameter is mandatory and specifies the module API name. The 'type' parameter can be used to specify the type of deleted records to retrieve, such as 'All', 'Recycle', or 'Permanent'. Pagination is supported through the 'page' and 'per_page' parameters. The response includes details about each deleted client, such as who deleted it, when it was deleted, and other metadata. The response also includes pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

Get list of deleted Contacts

ID: get_list_of_deleted_contacts
Operation: read
Entities: Contact
Summary: The 'Get list of deleted Contacts' API retrieves a list of contacts that have been deleted from the Zoho Recruit system. The API requires an OAuth token for authentication and supports optional headers and query parameters to filter the results. The 'If-Modified-Since' header can be used to fetch recently deleted records. The 'module' parameter is mandatory and specifies the module API name. The 'type' parameter can be used to specify the type of deleted records to retrieve, such as 'All', 'Recycle', or 'Permanent'. Pagination is supported through the 'page' and 'per_page' parameters. The response includes details about each deleted contact, such as who deleted it, when it was deleted, and its display name, along with pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

Get list of deleted Departments

ID: get_list_of_deleted_departments
Operation: read
Entities: module, department, record
Summary: The 'Get list of deleted Departments' API retrieves a list of departments that have been deleted from the Zoho Recruit system. The API requires an OAuth token for authentication and supports optional headers and query parameters to filter the results. The 'module' parameter is mandatory and specifies the module API name. The 'type' parameter can be used to specify the type of deleted records to retrieve, such as 'All', 'Recycle', or 'Permanent'. Pagination is supported through the 'page' and 'per_page' parameters. The response includes details about each deleted department, such as who deleted it, when it was deleted, and its display name. The response also provides pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

Get list of deleted Events

ID: get_list_of_deleted_events
Operation: read
Entities: event
Summary: The 'Get list of deleted Events' API retrieves a list of events that have been deleted from the Zoho Recruit system. The API requires an OAuth token for authentication and supports optional headers and query parameters to filter the results. The 'module' parameter is mandatory and specifies the module API name. The 'type' parameter can be used to specify the type of deleted records to retrieve, such as 'All', 'Recycle', or 'Permanent'. Pagination is supported through the 'page' and 'per_page' parameters. The response includes details about each deleted event, such as who deleted it, when it was deleted, and its display name. The 'info' object in the response provides pagination details.
Input Fields: Input Fields
Output Fields: Output Fields

Get list of deleted Interviews

ID: get_list_of_deleted_interviews
Operation: read
Entities: Interview
Summary: The 'Get list of deleted Interviews' API retrieves a list of interviews that have been deleted from the Zoho Recruit system. The API requires an OAuth token for authentication and supports optional headers and query parameters to filter the results. The 'module' parameter is mandatory and specifies the module API name. The 'type' parameter can be used to specify the type of deleted records to retrieve, such as 'All', 'Recycle', or 'Permanent'. Pagination is supported through the 'page' and 'per_page' parameters. The response includes details about each deleted interview, such as who deleted it, when it was deleted, and the type of deletion. The response also includes pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

Get list of deleted JobOpenings

ID: get_list_of_deleted_jobopenings
Operation: read
Entities: JobOpening, User
Summary: The 'Get list of deleted JobOpenings' API retrieves a list of job openings that have been deleted from the Zoho Recruit system. The API requires an OAuth token for authentication and supports optional headers and query parameters to filter the results. The 'module' parameter is mandatory and specifies the module API name. The 'type' parameter can be used to specify the type of deleted records to retrieve, such as 'All', 'Recycle', or 'Permanent'. Pagination is supported through the 'page' and 'per_page' parameters. The response includes details about each deleted job opening, such as who deleted it, when it was deleted, and other metadata. The response also includes pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

Get List of Deleted Records

ID: get_list_of_deleted_records
Operation: read
Entities: user, module, record
Summary: The 'Get List of Deleted Records' API retrieves a list of deleted records from a specified module in Zoho Recruit. The API requires the module API name as a path parameter and supports optional query parameters such as 'type' to specify the type of deleted records (All, Recycle, or Permanent), 'page' for pagination, and 'per_page' to define the number of records per page. The 'If-Modified-Since' header can be used to fetch recently deleted records. The response includes details of each deleted record, such as the user who deleted it, the display name, and the deletion time, along with pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

Get list of deleted Reviews

ID: get_list_of_deleted_reviews
Operation: read
Entities: user, review, record
Summary: The 'Get list of deleted Reviews' API retrieves a list of reviews that have been deleted from the Zoho Recruit system. The API requires an authorization header with a valid Zoho OAuth token and session cookies. It accepts query parameters such as 'module' (mandatory), 'type', 'page', and 'per_page' to filter and paginate the results. The response includes details about each deleted review, such as who deleted it, when it was deleted, and its display name. The 'info' object in the response provides pagination details. The API supports filtering by deletion type (all, recycle, permanent) and can return recently deleted records using the 'If-Modified-Since' header.
Input Fields: Input Fields
Output Fields: Output Fields

Get list of deleted Submissions

ID: get_list_of_deleted_submissions
Operation: read
Entities: Submission
Summary: The 'Get list of deleted Submissions' API retrieves a list of submissions that have been deleted from the Zoho Recruit system. The API requires an OAuth token for authentication and allows filtering by module, type of deletion (all, recycle, or permanent), and pagination options. The response includes details about each deleted submission, such as who deleted it, when it was deleted, and its display name. The API also provides pagination information to help manage large sets of data.
Input Fields: Input Fields
Output Fields: Output Fields

Get list of deleted Tasks

ID: get_list_of_deleted_tasks
Operation: read
Entities: task
Summary: The 'Get list of deleted Tasks' API retrieves a list of tasks that have been deleted from the Zoho Recruit system. It requires an authorization token and session cookies in the headers. The API accepts query parameters such as 'module' (mandatory), 'type', 'page', and 'per_page' to filter and paginate the results. The response includes details about each deleted task, such as who deleted it, when it was deleted, and its display name. The response also provides pagination information. The API can return errors if invalid data is provided, such as an incorrect 'type' parameter.
Input Fields: Input Fields
Output Fields: Output Fields

Get list of deleted Vendors

ID: get_list_of_deleted_vendors
Operation: read
Entities: vendor
Summary: The 'Get list of deleted Vendors' API retrieves a list of vendors that have been deleted from the Zoho Recruit system. The API requires an OAuth token for authorization and accepts optional headers and query parameters. The 'module' parameter is mandatory and specifies the module API name. The 'type' parameter can be used to filter the type of deleted records (All, Recycle, or Permanent). Pagination is supported through 'page' and 'per_page' parameters. The response includes details about each deleted vendor, such as who deleted it, when it was deleted, and the type of deletion. The response also provides pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

Get List of Modules in Zoho Recruit

ID: get_list_of_modules_in_zoho_recruit
Operation: read
Entities: profile, module
Summary: The 'Get List of Modules in Zoho Recruit' API retrieves the list of modules available in a Zoho Recruit account. It requires an OAuth token for authentication, which should be included in the request headers. The API returns a list of modules, each with details such as whether it supports global search, if it is deletable or creatable, the profiles associated with it, and other attributes. The response includes information about each module's API name, which is crucial for accessing the module in third-party integrations. The API supports various scopes, including full data access and read-only access.
Input Fields: Input Fields
Output Fields: Output Fields

Get List of Notes

ID: get_list_of_notes
Operation: read
Entities: candidate, note, application
Summary: The 'Get List of Notes' API is used to retrieve a list of notes associated with various modules in Zoho Recruit, such as Candidates, Applications, Job Openings, and more. The API uses a GET request to the endpoint 'https://recruit.zoho.com/recruit/v2/Notes'. It requires an 'Authorization' header with a valid OAuth token. Optional query parameters 'page' and 'per_page' can be used to paginate the results, with default values of 1 and 200, respectively. The response includes an array of note objects, each containing details such as 'Modified_Time', 'Created_Time', 'Note_Owner', 'Note_Title', and 'Note_Content'. The 'info' object in the response provides pagination details like 'per_page', 'count', 'page', and 'more_records'.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Metadata for Zoho Recruit Module

ID: get_metadata_for_zoho_recruit_module
Operation: read
Entities: related_list, module, field
Summary: This API retrieves the metadata for fields, layouts, and related lists for a specified module in Zoho Recruit. The user must specify the API name of the module, such as Candidates, Contacts, or Job Openings, in the request URL. The API supports various modules like candidate, jobopenings, interview, client, contact, department, task, event, vendor, campaign, referral, review, submission, and custommodule. The response includes details about the module's properties, profiles, attachment types, and custom views. The API requires an OAuth token for authentication and supports scopes like ZohoRecruit.settings.modules.read, ZohoRecruit.settings.modules.all, and ZohoRecruit.settings.all. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Modules Candidates

ID: get_modules_candidates
Operation: read
Entities: profile, module, field
Summary: The 'Modules Candidates' API retrieves metadata for fields, layouts, and related lists for the 'Candidates' module in Zoho Recruit. It provides detailed information about the module's properties, including whether it is creatable, deletable, and editable, as well as the profiles associated with it. The API requires an authorization header with a Zoho OAuth token. The response includes a list of modules with their metadata, such as import permissions, global search support, and attachment types. The API supports various scopes, including read and full access. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Modules Clients

ID: get_modules_clients
Operation: read
Entities: related_list, module, field
Summary: The 'Modules Clients' API retrieves metadata for fields, layouts, and related lists for the 'Clients' module in Zoho Recruit. It provides details such as the fields available, related list properties, and module settings. The API requires an OAuth token for authentication and returns a comprehensive JSON response containing module details like global search support, creatable status, profiles, attachment types, and custom views. The API supports scopes for reading module settings and provides error messages for invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Modules Contacts

ID: get_modules_contacts
Operation: read
Entities: related_list, module, field
Summary: The 'Modules Contacts' API retrieves metadata for fields, layouts, and related lists for the Contacts module in Zoho Recruit. It provides detailed information about the module, including its properties, profiles, attachment types, and custom views. The API requires an Authorization header with a Zoho OAuth token. The response includes metadata such as whether the module is creatable, deletable, or viewable, and details about related lists and custom views. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Modules Departments

ID: get_modules_departments
Operation: read
Entities: module, layout, field
Summary: The 'Modules Departments' API retrieves metadata for fields, layouts, and related lists for the specified module in Zoho Recruit. It provides details such as whether the module supports global search, is deletable, creatable, and editable, among other properties. The API requires an Authorization header with a Zoho OAuth token. The response includes a list of modules with their metadata, including profiles, attachment types, and custom views. The API supports scopes for reading module settings and provides error messages for invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Modules Events

ID: get_modules_events
Operation: read
Entities: module, layout, field
Summary: The 'Modules Events' API retrieves metadata for fields, layouts, and related lists for the specified module 'Events' in Zoho Recruit. It provides details such as whether the module is creatable, deletable, and viewable, along with properties like profiles, attachment types, and custom views. The API requires an Authorization header with a Zoho OAuth token. The response includes a list of modules with detailed metadata, including fields, profiles, and related list properties. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Modules Interviews

ID: get_modules_interviews
Operation: read
Entities: module, layout, field
Summary: The 'Modules Interviews' API endpoint retrieves metadata for fields, layouts, and related lists for the 'Interviews' module in Zoho Recruit. It provides details such as global search support, deletability, creatability, profiles, and attachment types. The API requires an OAuth token for authentication and returns a comprehensive JSON response detailing the module's properties, profiles, and custom views. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Modules JobOpenings

ID: get_modules_jobopenings
Operation: read
Entities: profile, module, field
Summary: The 'Modules JobOpenings' API retrieves metadata for fields, layouts, and related lists for the specified module 'Job Openings'. It provides details such as global search support, deletability, creatability, profiles associated, and more. The API requires an Authorization header with a Zoho OAuth token. The response includes a list of modules with properties like global_search_supported, deletable, creatable, profiles, and attachment types. The API supports scopes like ZohoRecruit.settings.modules.read and ZohoRecruit.settings.modules.all. Possible errors include INVALID_MODULE for invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Modules Submissions

ID: get_modules_submissions
Operation: read
Entities: related_list, module, field
Summary: The 'Modules Submissions' API retrieves metadata for fields, layouts, and related lists for the 'Submissions' module in Zoho Recruit. It provides details such as the fields available, related lists, and module properties. The API requires an OAuth token for authentication and returns a comprehensive JSON response detailing the module's capabilities, profiles, custom views, and attachment types. It supports operations like reading records and provides error messages for invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Modules Tasks

ID: get_modules_tasks
Operation: read
Entities: module, layout, field
Summary: The 'Modules Tasks' API endpoint retrieves metadata for fields, layouts, and related lists for the specified module 'Tasks'. It provides detailed information about the module, including its properties, profiles, related list properties, and custom views. The API requires an authorization header with a Zoho OAuth token. The response includes a comprehensive list of module attributes such as global search support, creatability, editability, and more. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Modules Vendors

ID: get_modules_vendors
Operation: read
Entities: profile, attachmenttype, module
Summary: The 'Modules Vendors' API retrieves metadata for fields, layouts, and related lists for the 'Vendors' module in Zoho Recruit. It provides details such as whether the module supports global search, is deletable, creatable, and editable, among other properties. The API requires an authorization header with a Zoho OAuth token. The response includes a list of modules with detailed metadata, including profiles, attachment types, and custom views. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Get Note Type

ID: get_note_type
Operation: read
Entities: note_type
Summary: The 'Get Note Type' API retrieves a list of all note types available in your Zoho Recruit account. It requires an OAuth token for authentication and a scope parameter to define the level of access. The response includes an array of note types, each with a name, unique identifier, and a flag indicating if it is the default type. Additionally, the response provides pagination information such as the number of records per page, the total count of note types returned, the current page number, and whether there are more records to fetch.
Input Fields: Input Fields
Output Fields: Output Fields

Get Organization Data

ID: get_organization_data
Operation: read
Entities: license_details, organization, address
Summary: The Get Organization Data API retrieves information about an organization from Zoho Recruit. It requires an OAuth token for authentication, which should be included in the request headers. The API returns details such as employee count, location, website, time zone, multi-currency status, and license details of the organization. The response includes various attributes like company name, primary email, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Get Profile Details in Zoho Recruit

ID: get_profile_details_in_zoho_recruit
Operation: read
Entities: profile, access_level, user
Summary: This API retrieves the details of different profiles in Zoho Recruit. The administrator assigns a profile to every user, which determines the user's level of access to Zoho Recruit data. The API can be used to get all profiles or a specific profile by providing the profile ID. The request requires an Authorization header with a valid OAuth token. The response includes details such as the profile name, description, ID, and whether it is a custom profile.
Input Fields: Input Fields
Output Fields: Output Fields

Record Count for a Specific Tag

ID: get_record_count_for_specific_tag
Operation: read
Entities: configuration, tag, record
Summary: The 'Record Count for a Specific Tag' API retrieves the total number of records associated with a specific tag in Zoho Recruit. The API requires the tag's unique ID as a path parameter and an authorization token in the headers. An optional query parameter 'configurations' can be set to 'true' to get all areas where the tag is configured. The response includes details of configured areas and the count of records associated with the tag. Possible errors include invalid URL, OAuth scope mismatch, no permission, internal server error, invalid request method, and authorization failure.
Input Fields: Input Fields
Output Fields: Output Fields

Get Records from a Module

ID: get_records_from_a_module
Operation: read
Entities: parameter, module, record
Summary: The Get Records API allows users to retrieve a list of records from a specified module in Zoho Recruit. The API supports various query parameters to filter and sort the records, such as fields, sort_order, sort_by, converted, approved, page, per_page, cvid, territory_id, include_child, and $state. The API also supports an optional header 'If-Modified-Since' to fetch recently modified records. The response includes detailed information about each record, such as account manager, last activity time, client name, and more. The API is accessible via a GET request to the endpoint 'https://recruit.zoho.com/recruit/v2/{module_api_name}'.
Input Fields: Input Fields
Output Fields: Output Fields

Get Related List Data of a Module

ID: get_related_list_data_of_a_module
Operation: read
Entities: setting, related_list, module
Summary: This API retrieves the related list data of a specified module in Zoho Recruit. The request requires the module's API name as a query parameter and an OAuth token for authentication in the headers. The response includes an array of related lists, each with details such as sequence number, list label, API name, module, name, ID, href, and type. The API supports modules like candidate, jobopenings, interview, client, contact, department, task, event, vendor, campaign, referral, review, submission, and custommodule. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Related list Metadata Candidates

ID: get_related_list_metadata_candidates
Operation: read
Entities: related_list, module, candidate
Summary: The 'Related list Metadata Candidates' API retrieves the related list data of a specified module in Zoho Recruit. The API requires an OAuth token for authentication and a mandatory query parameter 'module' to specify the module name, such as Candidates, Contacts, Clients, etc. The response includes a list of related metadata, each with details like sequence number, list label, API name, module, name, ID, href, and type. The 'href' attribute in the response can be used to construct URLs for accessing specific related lists. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Related List Metadata Clients

ID: get_related_list_metadata_clients
Operation: read
Entities: related_list, client, module
Summary: The 'Related List Metadata Clients' API retrieves the related list data of a specified module in Zoho Recruit. The API requires an OAuth token for authentication and a mandatory query parameter 'module' to specify the module name. The response includes metadata about related lists such as sequence number, list label, API name, module, name, ID, and href. The 'href' attribute can be used to construct URLs for accessing specific related lists. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Related list Metadata Contacts

ID: get_related_list_metadata_contacts
Operation: read
Entities: related_list, error, module
Summary: The 'Related list Metadata Contacts' API retrieves the related list data for a specified module in Zoho Recruit. The API requires an OAuth token for authentication and a mandatory query parameter 'module' to specify the module name, such as Contacts, Candidates, etc. The response includes a list of related lists with details like sequence number, list label, API name, module, name, ID, href, and type. The 'href' attribute in the response can be used to call the related list API for specific entities.
Input Fields: Input Fields
Output Fields: Output Fields

Related List Metadata for Departments

ID: get_related_list_metadata_departments
Operation: read
Entities: module, related_list, department
Summary: The 'Related List Metadata for Departments' API retrieves the related list data for a specified module in Zoho Recruit. The API requires an OAuth token for authentication and a mandatory query parameter 'module' to specify the module name. The response includes a list of related lists with details such as sequence number, list label, API name, module, name, ID, href, and type. The 'href' attribute in the response can be used to construct URLs for accessing specific related lists. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Related list Metadata Events

ID: get_related_list_metadata_events
Operation: read
Entities: related_list, module, event
Summary: The 'Related list Metadata Events' API retrieves the related list data of a specified module in Zoho Recruit. The API requires an OAuth token for authentication and a mandatory query parameter 'module' to specify the API name of the required module. The response includes a list of related lists with details such as sequence number, list label, API name, module, name, ID, href, and type. The 'href' attribute in the response can be used to call the related list API. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Related List Metadata for Tasks

ID: get_related_list_metadata_for_tasks
Operation: read
Entities: related_list, error, module
Summary: This API retrieves the related list metadata for a specified module, in this case, 'Tasks'. It requires an OAuth token for authentication and the module name as a query parameter. The response includes a list of related lists with details such as sequence number, list label, API name, module, name, ID, href, and type. The 'href' attribute in the response can be used to call the related list API for specific entities.
Input Fields: Input Fields
Output Fields: Output Fields

Related list Metadata Interviews

ID: get_related_list_metadata_interviews
Operation: read
Entities: related_list, module, interview
Summary: The 'Related list Metadata Interviews' API retrieves the related list data for the 'Interviews' module in Zoho Recruit. It requires an OAuth token for authentication and the module name as a query parameter. The response includes a list of related lists with details such as sequence number, list label, API name, module, name, ID, href, and type. The API supports scopes for reading related lists and provides error messages for invalid module names.
Input Fields: Input Fields
Output Fields: Output Fields

Related List Metadata for Job Openings

ID: get_related_list_metadata_job_openings
Operation: read
Entities: job_opening, related_list, module
Summary: The 'Related List Metadata for Job Openings' API retrieves the related list data for a specified module in Zoho Recruit. The API requires an OAuth token for authentication and a mandatory query parameter 'module' to specify the module name, such as JobOpenings. The response includes an array of related lists with details like sequence number, list label, API name, module, name, ID, href, and type. The 'href' attribute in the response can be used to construct URLs for accessing specific related lists. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Related list Metadata Reviews

ID: get_related_list_metadata_reviews
Operation: read
Entities: review, related_list, module
Summary: The 'Related list Metadata Reviews' API is used to retrieve the related list data of a specified module in Zoho Recruit. The API requires an OAuth token for authentication and a mandatory query parameter 'module' to specify the API name of the required module. The response includes details about the related lists such as sequence number, list label, API name, module, name, ID, href, and type. The 'href' attribute in the response can be used to call the related list API for further operations. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Related list Metadata Submissions

ID: get_related_list_metadata_submissions
Operation: read
Entities: parameter, related_list, module
Summary: The 'Related list Metadata Submissions' API retrieves the related list data of a specified module in Zoho Recruit. The API requires an OAuth token for authentication and a mandatory query parameter 'module' to specify the API name of the required module. The response includes a list of related lists with details such as sequence number, list label, API name, module, name, ID, href, and type. The 'href' attribute in the response can be used to call the related list API for specific entities. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Related list Metadata Vendors

ID: get_related_list_metadata_vendors
Operation: read
Entities: vendor, related_list, module
Summary: The 'Related list Metadata Vendors' API retrieves the related list data for a specified module in Zoho Recruit. The API requires an OAuth token for authentication and a mandatory query parameter 'module' to specify the module name, such as Vendors, Candidates, Contacts, etc. The response includes a list of related lists with details such as sequence number, list label, API name, module, name, ID, href, and type. The 'href' attribute in the response can be used to construct URLs for accessing specific related lists. Possible errors include invalid module names or unsupported modules.
Input Fields: Input Fields
Output Fields: Output Fields

Get Related Records

ID: get_related_records
Operation: read
Entities: module, record, related_module
Summary: The Get Related Records API retrieves a list of records related to a specific record in Zoho Recruit, such as Notes, Attachments, etc. The API requires the module API name, record ID, and related module as path parameters. It supports optional query parameters like ids, sort_order, sort_by, page, per_page, and fields to customize the response. The API returns a JSON response containing the related records and pagination information. Supported modules include Candidates, Clients, Contacts, and more, while related modules include Notes, Attachments, Interviews, and others. The API handles errors such as invalid relation names or IDs and internal server errors.
Input Fields: Input Fields
Output Fields: Output Fields

Get related records for applications

ID: get_related_records_for_applications
Operation: read
Entities:
Summary: The 'Get related records for applications' API allows users to retrieve attachments related to a specific application in the Zoho Recruit system. The API requires the application's ID as a path parameter and supports various optional query parameters such as 'ids' for specific related record IDs, 'sort_order' and 'sort_by' for sorting, 'page' and 'per_page' for pagination, and 'fields' for specifying which fields to include in the response. The response includes detailed information about each attachment, such as its type, modification time, category, file name, size, and ownership details. The API also provides pagination information in the 'info' object. Authentication is required via an OAuth token in the request headers.
Input Fields: Input Fields
Output Fields: Output Fields

Get related records for candidates

ID: get_related_records_for_candidates
Operation: read
Entities: candidate, attachment
Summary: The 'Get related records for candidates' API allows users to retrieve attachments related to a specific candidate in the Zoho Recruit system. The API requires the candidate's ID as a path parameter and supports various optional query parameters such as 'ids' for specific related record IDs, 'sort_order' and 'sort_by' for sorting, 'page' and 'per_page' for pagination, and 'fields' for specifying which fields to include in the response. The response includes detailed information about each attachment, such as its type, modification time, category, file name, size, and ownership details. The API also provides pagination information in the 'info' object. Authentication is required via an OAuth token in the request headers.
Input Fields: Input Fields
Output Fields: Output Fields

Get related records for Clients

ID: get_related_records_for_clients
Operation: read
Entities: Client, Note
Summary: The 'Get related records for Clients' API retrieves notes related to a specific client in Zoho Recruit. The API requires the client ID as a path parameter and supports various optional query parameters such as 'ids' for specific related record IDs, 'sort_order' and 'sort_by' for sorting, 'page' and 'per_page' for pagination, and 'fields' to specify which fields to include in the response. The response includes detailed information about each note, such as modification and creation times, parent ID, note owner, and content. The API also handles errors such as invalid relation names or IDs and internal server errors.
Input Fields: Input Fields
Output Fields: Output Fields

Get related records for Contacts

ID: get_related_records_for_contacts
Operation: read
Entities: Note, Contact
Summary: The 'Get related records for Contacts' API allows users to retrieve notes related to a specific contact in Zoho Recruit. The API requires the ContactID as a path parameter and supports various optional query parameters such as 'ids' for specifying related record IDs, 'sort_order' and 'sort_by' for sorting the records, 'page' and 'per_page' for pagination, and 'fields' for selecting specific fields to include in the response. The response includes a list of notes with details such as modification time, creation time, note owner, and content. The API also provides pagination information in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Get related records for Events

ID: get_related_records_for_events
Operation: read
Entities: Note, Event
Summary: The 'Get related records for Events' API retrieves related notes for a specified event in Zoho Recruit. The API requires an event ID as a path parameter and an authorization token in the headers. Optional query parameters include 'ids' for specifying related record IDs, 'sort_order' and 'sort_by' for sorting, 'page' and 'per_page' for pagination, and 'fields' for specifying which fields to include in the response. The response includes a list of related notes with details such as modification time, creation time, note owner, and content. The API also provides pagination information in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Get related records for Interviews

ID: get_related_records_for_interviews
Operation: read
Entities: note, interview
Summary: This API retrieves related notes for a specific interview in Zoho Recruit. The endpoint requires the interview ID as a path parameter. Optional query parameters include 'ids' for specifying related record IDs, 'sort_order' and 'sort_by' for sorting, 'page' and 'per_page' for pagination, and 'fields' for specifying which fields to include in the response. The response includes details about each note, such as modification time, creation time, note owner, and content. The API requires an OAuth token for authentication and supports session cookies. Possible errors include invalid relation names or IDs, and internal server errors.
Input Fields: Input Fields
Output Fields: Output Fields

Get related records for Vendors

ID: get_related_records_for_vendors
Operation: read
Entities: vendor, note
Summary: The 'Get related records for Vendors' API allows users to retrieve related notes for a specific vendor in the Zoho Recruit system. The API requires an OAuth token for authentication and the vendor ID as a path parameter. Optional query parameters include 'ids' for specifying related record IDs, 'sort_order' and 'sort_by' for sorting, 'page' and 'per_page' for pagination, and 'fields' for specifying which fields to include in the response. The response includes detailed information about each note, such as modification and creation times, note owner, and content. The API also provides pagination information in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Interview Details for a Candidate

ID: get_retrieve_interview_details_for_candidate
Operation: ['read', 'read']
Entities:
Summary: This configuration retrieves all interview details for a specific candidate using the Zoho Recruit API. It first fetches the Candidate ID using the 'Get Specific Job Application Details' API and then uses this ID to search for interviews with the 'Search Interviews' API. The search is performed using a criteria parameter that includes the Candidate ID. The response includes detailed information about each interview, such as client name, posting title, start and end times, candidate name, and interviewer details. The API requires an OAuth token for authorization.
Input Fields: Input Fields
Output Fields: Output Fields

Get Reviews

ID: get_reviews
Operation: read
Entities: Review, Candidate, User
Summary: The Get Reviews API allows users to retrieve reviews from the Zoho Recruit module. It supports various query parameters to filter and sort the reviews, such as fields, sort_order, sort_by, converted, approved, page, per_page, cvid, territory_id, include_child, and $state. The API requires an Authorization header with a Zoho OAuth token. The response includes detailed information about each review, such as Review_Comments, Rating, Source, Modified_By, Candidate_Name, Review_ID, Reviewed_By, Review_Owner, and more. The response also provides pagination information through the 'info' object.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Roles Information in Zoho Recruit

ID: get_roles_information
Operation: read
Entities: user, administrator, role
Summary: This API retrieves information about various roles in Zoho Recruit. It can be used to get a list of all roles or details of a specific role by providing the role ID. The request requires an OAuth token for authentication. The response includes details such as the display label, name, ID, and reporting hierarchy of each role.
Input Fields: Input Fields
Output Fields: Output Fields

Search Candidates

ID: get_search_candidates
Operation: read
Entities: search, criteria, candidate
Summary: The Search Candidates API allows users to search for candidate records in the Zoho Recruit system based on various criteria. The API supports searching by criteria, email, phone, or word, with a preference order if multiple parameters are provided. The search criteria can include up to 10 conditions using 'equals' or 'starts_with'. The API also supports pagination with 'page' and 'per_page' parameters. The response includes detailed candidate information such as email, phone, status, and more, along with pagination info. Authorization is required via a Zoho OAuth token.
Input Fields: Input Fields
Output Fields: Output Fields

Search Clients

ID: get_search_clients
Operation: read
Entities: client, module, record
Summary: The Search Clients API allows users to search for client records in the Zoho Recruit system using various criteria. The API supports searching by criteria, email, phone, or word, with a preference order if multiple parameters are provided. It also supports pagination through 'page' and 'per_page' parameters. The response includes detailed client information and pagination info. The API requires an OAuth token for authorization.
Input Fields: Input Fields
Output Fields: Output Fields

Search Contacts

ID: get_search_contacts
Operation: read
Entities: Contact
Summary: The Search Contacts API allows users to search for contact records in the Zoho Recruit system using various criteria such as email, phone, and specific search terms. The API supports pagination through the 'page' and 'per_page' parameters, allowing users to retrieve large sets of data in multiple requests. The search can be refined using criteria, email, phone, or word parameters, with a preference order if multiple are provided. The response includes the list of matching contact records along with pagination metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Search Interviews

ID: get_search_interviews
Operation: read
Entities: Job_Opening, Candidate, Interview
Summary: The Search Interviews API allows users to search for interview records in the Zoho Recruit system based on various criteria. The API supports searching by criteria, email, phone, or word, with criteria taking precedence if multiple parameters are provided. The search can be refined using optional parameters such as 'converted', 'approved', 'page', and 'per_page'. The response includes detailed information about each interview record, such as client name, posting title, start and end times, candidate name, and interviewer details. The API requires an OAuth token for authorization.
Input Fields: Input Fields
Output Fields: Output Fields

Search Job Openings

ID: get_search_job_openings
Operation: read
Entities: Assigned_Recruiter, Client_Name, JobOpening
Summary: The Search Job Openings API allows users to search for job openings in the Zoho Recruit system using various criteria. The API supports searching by criteria, email, phone, or word, with a preference order if multiple parameters are provided. The search criteria can include up to 10 conditions using 'equals' or 'starts_with'. The API also supports pagination with 'page' and 'per_page' parameters. The response includes detailed information about each job opening, such as client name, posting title, required skills, job type, and more. The API requires an OAuth token for authorization.
Input Fields: Input Fields
Output Fields: Output Fields

Search Records in Zoho Recruit

ID: get_search_records_in_zoho_recruit
Operation: read
Entities: search, module, record
Summary: The Search Records API in Zoho Recruit allows users to retrieve records that match specified search criteria from various modules such as Candidates, Applications, Job Openings, and more. The API supports multiple search parameters including criteria, email, phone, and word, but only one can be used at a time. The search criteria can include up to 10 conditions using 'equals' and 'starts_with'. The API also supports pagination through 'page' and 'per_page' parameters. The response includes detailed information about each record and pagination info.
Input Fields: Input Fields
Output Fields: Output Fields

Get Specific Job Application Details

ID: get_specific_job_application_details
Operation: read
Entities:
Summary: The Get Specific Job Application Details API retrieves comprehensive details of a specific job application from Zoho Recruit using the application ID as a path parameter. It requires an Authorization header with a Zoho OAuth token. The response includes detailed information about the application, such as the origin, client name, application status, email, candidate ID, posting title, assigned recruiters, and more. The response also provides pagination information, including the number of records per page, the current page, and whether more records are available.
Input Fields: Input Fields
Output Fields: Output Fields

Get Stages of Hiring Pipelines

ID: get_stages_of_a_job
Operation: read
Entities: stage, application status, application
Summary: This API retrieves all possible stages for ATS systems in recruting pipeline. In this app they are also referred as application Status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Submission

ID: get_submission
Operation: read
Entities: job_opening, submission, candidate
Summary: The Get Submission API retrieves a list of submission records from Zoho Recruit. It allows filtering and sorting of records based on various query parameters such as fields, sort order, converted status, approval status, and more. The API requires an Authorization header with a Zoho OAuth token. Optional headers include session cookies and a timestamp for retrieving recently modified records. The response includes detailed information about each submission, such as client name, submission name, candidate details, submission medium, status, and timestamps. Pagination information is also provided in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Get Tasks

ID: get_tasks
Operation: read
Entities: user, task, module
Summary: The Get Tasks API retrieves a list of tasks from the Zoho Recruit module. It supports various query parameters to filter and sort the tasks, such as fields, sort_order, sort_by, converted, approved, page, per_page, cvid, territory_id, include_child, and $state. The API requires an Authorization header with a Zoho OAuth token and session cookies. The response includes task details such as Description, Status, Priority, Subject, and more, along with pagination information. The API is accessible with the appropriate scope and is subject to certain limitations and possible errors.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve User Information from Zoho Recruit

ID: get_user_information_from_zoho_recruit
Operation: read
Entities: profile, role, user
Summary: The Retrieve User Information from Zoho Recruit API allows you to fetch basic information about users in Zoho Recruit. You can specify the type of users to retrieve using the 'type' query parameter, which can include values such as AllUsers, ActiveUsers, AdminUsers, etc. The API requires an OAuth token for authentication, provided in the Authorization header. The response includes detailed user information such as role, profile, email, status, and more, along with pagination details.
Input Fields: Input Fields
Output Fields: Output Fields

Get Vendors

ID: get_vendors
Operation: read
Entities: Vendor, Module, Record
Summary: The Get Vendors API retrieves a list of vendor records from the Zoho Recruit module. It supports various query parameters to filter and sort the records, such as 'fields' to specify which fields to retrieve, 'sort_order' and 'sort_by' to sort the records, and 'page' and 'per_page' to paginate the results. The API requires an Authorization header with a Zoho OAuth token. The response includes detailed information about each vendor, such as email, name, login status, and modification details, along with pagination info. The API also supports filtering by approval status, conversion status, and territory.
Input Fields: Input Fields
Output Fields: Output Fields

Add Tags to Records

ID: post_add_tags_to_records
Operation: write
Entities:
Summary: The Add Tags to Records API allows users to add tags to specific candidate in the Zoho Recruit system. The API requires the module API name and record ID as path parameters, and the tag names as query parameters. The request must include an authorization header with a valid OAuth token. The API supports adding tags to multiple records by specifying multiple record IDs and tag names in the query parameters. The response includes the status and message of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Create Assessment in Zoho Recruit

ID: post_create_assessment_in_zoho_recruit
Operation: write
Entities: assessment, rating, question
Summary: This API allows you to create an assessment in your Zoho Recruit account. Assessments are used to evaluate candidates systematically during the hiring process. The API requires you to specify the assessment name, category, type, and optionally a description and rating type. The request body can include sections with questions, each having properties like display label, data type, and pick list values. The response provides details about the created assessment, including its ID, creation time, and the user who created it.
Input Fields: Input Fields
Output Fields: Output Fields

Create Bulk Read Job for Exporting Records

ID: post_create_bulk_read_job
Operation: read
Entities: module, record, bulk_read_job
Summary: This API creates a bulk read job to export records from Zoho Recruit. The request requires an OAuth token for authentication and a query JSON object specifying the details of the bulk read job. Optionally, a callback URL can be provided to receive job status updates. The response includes the status of the API call, a message, and details about the created job, such as the job ID, operation type, and creation time. The API supports exporting records in CSV format by default, or in ICS format for the Events module if specified.
Input Fields: Input Fields
Output Fields: Output Fields

Create Bulk Write Job in Zoho Recruit

ID: post_create_bulk_write_job
Operation: write
Entities: module, field_mapping, bulk_write_job
Summary: The Create Bulk Write Job API in Zoho Recruit allows users to create a bulk write job for various modules such as candidate, job opening, client, interview, contact, department, and custom modules. The API requires an OAuth token for authorization and supports operations like insert, update, and upsert. The request body can include character encoding, operation type, callback URL, and resource details with module names, field mappings, and file IDs. The response provides the status, message, and details of the job, including the job ID and creator information. Possible errors include missing mandatory fields, invalid field names, and invalid file IDs.
Input Fields: Input Fields
Output Fields: Output Fields

Create Candidate Submission Record

ID: post_create_candidate_submission_record
Operation: write
Entities: client, submission, candidate
Summary: The Create Candidate Submission Record API allows users to submit a candidate to a client or hiring manager by creating a submission record in the Zoho Recruit system. The API requires an authorization token and accepts various parameters such as Candidate_Name, Client_Name, Job_Opening_Name, and Submitted_To, among others. The $medium parameter specifies the submission medium, and additional mail content can be provided if the medium is Email. The API returns a success message along with details of the created record, including timestamps and user information.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Review Record in Zoho Recruit

ID: post_create_new_review_record
Operation: write
Entities: Job Opening, Review, Candidate
Summary: This API allows you to create a new review record in the Reviews sub-module of Zoho Recruit. The Reviews sub-module acts as a bridge for associating Candidates, Job Openings, and Applications. When a Candidate is evaluated, the associated review is added as a record in Reviews. The API requires an OAuth token for authentication and accepts a JSON body with details such as Review Comments, Interview Name, Interview Status, Rating, Candidate Name, Assessment Name, and answers to assessment questions. The Rating is mandatory and must be between 1 and 5. The response includes details of the created record, including the creation and modification times, and the user who performed these actions.
Input Fields: Input Fields
Output Fields: Output Fields

Create New Tags

ID: post_create_new_tags
Operation: write
Entities: user, tag, module
Summary: The 'Create New Tags' API allows users to create new tags in the specified module within Zoho Recruit. The API requires a POST request to the endpoint with the module API name as a query parameter. The request must include an authorization header with a valid Zoho OAuth token. The body of the request should contain an array of tags, each with a name and color code. The response returns the status of the operation for each tag, including details such as creation and modification times, and the user who performed these actions.
Input Fields: Input Fields
Output Fields: Output Fields

Create Notes in Zoho Recruit

ID: post_create_notes_in_zoho_recruit
Operation: write
Entities:
Summary: The 'Create Notes in Zoho Recruit' API allows users to create a new note in their Zoho Recruit account. The API requires an OAuth token for authentication and accepts a JSON body containing the note details such as 'Note_Title', 'Note_Content', 'Parent_Id', and 'se_module'. The response includes details of the created note, including the ID, creation and modification times, and the user who created and last modified the note. The API supports various modules like candidate, jobopenings, Interview, client, contact, department, task, event, vendor, and custommodule. Possible errors include invalid module names, incorrect URLs, insufficient permissions, and missing mandatory fields.
Input Fields: Input Fields
Output Fields: Output Fields

Insert or Update Record in Zoho Recruit

ID: post_insert_or_update_record
Operation: write
Entities: module, record, field
Summary: The Insert or Update (upsert) API in Zoho Recruit allows you to insert or update a record in a specified module. The API checks for duplicate records based on the specified duplicate check fields. If a record is already present, it gets updated; otherwise, it is inserted. The API supports various modules such as candidates, client, contact, job opening, and more. The request requires an OAuth token for authentication and accepts a JSON body containing the data to be upserted and optional duplicate check fields. The response includes the status and details of the upserted records.
Input Fields: Input Fields
Output Fields: Output Fields

Insert Records into Zoho Recruit Module

ID: post_insert_records_into_module
Operation: write
Entities: module, record, field
Summary: The Insert Records API allows you to add new entities to a specified module in Zoho Recruit. The API supports various modules such as Candidates, Applications, Job Openings, Interviews, Clients, Contacts, Departments, Tasks, Events, Vendors, and Custom Modules. You can insert up to 100 records per API call. The request requires an OAuth token for authentication and the module API name as a path parameter. The request body should contain the data to be inserted, with each record represented as a JSON object. The API checks for duplicates based on unique fields and allows records to be inserted as drafts or in approval mode. The response includes details of the created records, including their IDs and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Insert Records into Zoho Recruit Module Interviews

ID: post_insert_records_into_zoho_recruit_module_interviews
Operation: write
Entities:
Summary: The Insert Records API allows you to add new entities to a specified module in Zoho Recruit. The API supports various modules such as Candidates, Applications, Job Openings, Interviews, Clients, Contacts, Departments, Tasks, Events, Vendors, and Custom Modules. You can insert up to 100 records per API call. The request requires an OAuth token for authentication and the module API name as a path parameter. The request body should contain the data to be inserted, with each record represented as a JSON object. The API checks for duplicates based on unique fields and allows records to be inserted as drafts or in approval mode. The response includes details of the created records, including their IDs and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Insert Records into Zoho Recruit JobOpenings

ID: post_insert_records_into_zoho_recruit_module_job_openings
Operation: write
Entities:
Summary: The Insert Records API allows you to add new entities to a specified module in Zoho Recruit. The API supports various modules such as Candidates, Applications, Job Openings, Interviews, Clients, Contacts, Departments, Tasks, Events, Vendors, and Custom Modules. You can insert up to 100 records per API call. The request requires an OAuth token for authentication and the module API name as a path parameter. The request body should contain the data to be inserted, with each record represented as a JSON object. The API checks for duplicates based on unique fields and allows records to be inserted as drafts or in approval mode. The response includes details of the created records, including their IDs and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Merge Tags in Zoho Recruit

ID: post_merge_tags_in_zoho_recruit
Operation: write
Entities: tag
Summary: The Merge Tags API in Zoho Recruit allows users to merge two tags and move all associated records under the newly merged tag. The API requires a POST request to the specified URL with the tag_id as a path parameter. The request must include an Authorization header with a valid OAuth token. The body of the request should contain the conflict_id to resolve any conflicts during the merge. The response will include details of the merged tag, including the created and modified times and the users who performed these actions. Possible errors include invalid URL patterns, OAuth scope mismatches, and permission issues.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Tags from Records

ID: post_remove_tags_from_records
Operation: write
Entities: tag, module, record
Summary: The Remove Tags from Records API allows users to remove one or more tags from a specific record or multiple records in a specified module. The API requires the module API name and record ID(s) as path parameters, and the tag names to be removed as query parameters. The request must include an Authorization header with a valid OAuth token. The response returns the status of the operation, including the updated list of tags for the record(s).
Input Fields: Input Fields
Output Fields: Output Fields

Upload an Attachment to a Application

ID: post_upload_attachment_to_application
Operation: write
Entities:
Summary: This API allows you to attach a file to a specific record in Zoho Recruit. The request must include the file as multipart/form-data and requires an OAuth token for authentication. The URL includes path parameters for the module API name and record ID. Query parameters include mandatory fields for attachment category ID and label, and an optional attachment URL. The file size limit is 20MB, and all file types except .exe are supported. The response includes a success or failure code, a message, and additional details such as the attachment ID.
Input Fields: Input Fields
Output Fields: Output Fields

Upload an Attachment to a Record

ID: post_upload_attachment_to_record
Operation: write
Entities: record, module, attachment
Summary: This API allows you to attach a file to a specific record in Zoho Recruit. The request must include the file as multipart/form-data and requires an OAuth token for authentication. The URL includes path parameters for the module API name and record ID. Query parameters include mandatory fields for attachment category ID and label, and an optional attachment URL. The file size limit is 20MB, and all file types except .exe are supported. The response includes a success or failure code, a message, and additional details such as the attachment ID.
Input Fields: Input Fields
Output Fields: Output Fields

Upload CSV File in ZIP Format for Bulk Write

ID: post_upload_csv_file_in_zip_format_for_bulk_write
Operation: write
Entities: bulk_write, file
Summary: This API endpoint allows users to upload a CSV file in ZIP format for bulk write operations in Zoho Recruit. The request must include headers for authorization, feature indication, and organization ID. The file parameter is mandatory and must be in ZIP format. Upon successful upload, the response includes a file_id, which is used for subsequent bulk write requests. Possible errors include invalid file format, file size too large, incorrect URL, insufficient permissions, and internal server errors.
Input Fields: Input Fields
Output Fields: Output Fields

Upload a Document to Zoho Recruit

ID: post_upload_document_to_zoho_recruit
Operation: write
Entities: candidate, resume
Summary: This API endpoint allows users to upload resumes individually to the Zoho Recruit parser. The request must include the base64 encoded data of the document and the filename as parameters. The API requires an OAuth token for authorization. The response will indicate the success or failure of the upload operation.
Input Fields: Input Fields
Output Fields: Output Fields

Upload a Photo to a Record

ID: post_upload_photo_to_record
Operation: write
Entities: photo, module, record
Summary: This API allows you to upload a photo to a specific record in the Zoho Recruit system. The request must be made to the URL 'https://recruit.zoho.com/recruit/v2/{module_name}/{id}/photo' using the POST method. The 'module_name' and 'id' are path parameters representing the module and record ID respectively. The request must include an 'Authorization' header with a valid OAuth token and a 'Content-Type' header set to 'multipart/form-data'. The body of the request should contain a 'file' parameter with the photo to be uploaded. The response will include a status code, message, and additional details about the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Associate Candidate with Job Opening

ID: put_associate_candidate_with_job_opening
Operation: write
Entities:
Summary: This API associates a candidate with one or more job openings in the Zoho Recruit system. The request requires an authorization token and a body containing the job opening IDs and candidate IDs to be associated. The response indicates the success or failure of the operation, with detailed messages and status codes. Possible errors include already associated candidates, missing mandatory parameters, invalid candidate IDs, and locked or deleted records.
Input Fields: Input Fields
Output Fields: Output Fields

Cancel Interview

ID: put_cancel_interview
Operation: write
Entities: candidate, interview
Summary: The Cancel Interview API allows users to cancel a scheduled interview by sending a PUT request to the specified endpoint. The request requires an OAuth token for authentication and the unique record ID of the interview to be cancelled. The request body must include the reason for cancellation and any additional feedback. The API responds with the status of the cancellation, including the ID of the cancelled interview and a success message. The API call may fail if the candidate record is locked, if the interview is a recorded video interview with submitted answers, or if the interview is involved in a blueprint process.
Input Fields: Input Fields
Output Fields: Output Fields

Change Status of Candidate or Job Opening

ID: put_change_status_of_an_application
Operation: write
Entities:
Summary: The Change Status of Application API allows you to update the status of an application in Zoho Recruit. This API requires an OAuth token for authentication in the headers. The request method is PUT, and the input includes the candidate or job opening IDs, the new status, and optional comments. The response provides details of the modification, including the modified time, the user who modified it, and a success message.
Input Fields: Input Fields
Output Fields: Output Fields

Change Status of Candidate or Job Opening

ID: put_change_status_of_candidate_or_job_opening
Operation: write
Entities: offer, job_opening, candidate
Summary: The Change Status API allows you to change the status of a candidate or job opening in Zoho Recruit. The API requires the module API name. The request method is PUT, and it requires an OAuth token for authentication. The input includes the candidate or job opening IDs, the new status, and optional comments. The response includes details of the modification, such as the modified time, the user who modified it, and a success message.
Input Fields: Input Fields
Output Fields: Output Fields

Change Submission Status

ID: put_change_submission_status
Operation: write
Entities: status, reviewer, submission
Summary: The Change Submission Status API allows you to add a review and change the status of a submission record. The API endpoint requires a unique record ID and supports changing the status of one submission at a time. The request method is PUT, and it requires an OAuth token for authentication. The request body must include the submission status, rating, and optionally reviewer comments and the ID of the reviewer. The submission status can be 'Approved by hiring manager', 'Rejected by hiring manager', 'Approved by client', or 'Rejected by client'. The rating must be between 0 and 5, and the reviewer comments are mandatory if the status is 'Rejected by hiring manager'. The API returns a response indicating the success or failure of the operation, along with details of the modification.
Input Fields: Input Fields
Output Fields: Output Fields

Revoke Blueprint Process for a Record

ID: put_revoke_blueprint_process_for_a_record
Operation: write
Entities: module, record, blueprint
Summary: This API is used to remove a specified record from the blueprint process it is part of in Zoho Recruit. The request requires the module API name and the unique record ID as path parameters. The request must include an Authorization header with a valid OAuth token. The API supports modules such as candidates, job_opening, interview, client, contact, department, vendor, application, task, event, and referral. If the module name is invalid or the record is not part of any blueprint processes, appropriate error messages will be returned.
Input Fields: Input Fields
Output Fields: Output Fields

Update Assessment in Zoho Recruit

ID: put_update_assessment_in_zoho_recruit
Operation: write
Entities: assessment, question, category
Summary: This API allows you to update an assessment in your Zoho Recruit account. The request URL includes the unique record ID of the assessment to be updated. The request method is PUT. The input includes headers for authorization, path parameters for the record ID, and a request body containing details of the assessment such as Assessment_Name, Category, Type, Rating_Type, Description, and $sections which include questions and their details. The response returns a success message with details of the modified record, including the modified time, modified by, created time, and created by information.
Input Fields: Input Fields
Output Fields: Output Fields

Update Existing Note in Zoho Recruit

ID: put_update_existing_note_in_zoho_recruit
Operation: write
Entities: jobopening, note, candidate
Summary: This API allows you to update an existing note in your Zoho Recruit account. The request requires an OAuth token for authentication and the ID of the note to be updated as a path parameter. The request body must include the new title and content for the note. The response will indicate whether the update was successful and provide details about the note, including the creation and modification times, and the users who created and modified the note.
Input Fields: Input Fields
Output Fields: Output Fields

Update Records in Zoho Recruit

ID: put_update_records_in_zoho_recruit
Operation: write
Entities: module, record, field
Summary: The Update Records API in Zoho Recruit allows you to update existing entities in a specified module. The API endpoint requires the module API name and the record ID as path parameters. The request method is PUT, and it requires an Authorization header with a Zoho OAuth token. The request body should contain an array of records with their respective IDs and fields to be updated. The API supports various modules such as candidate, application, jobopening, and more. The response returns the status of the update operation along with details of the modified records.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Specific Review Record in Zoho Recruit

ID: put_update_specific_review_record
Operation: write
Entities: Candidates, Reviews, Job Openings
Summary: This API allows users to update a specific review record in the Reviews sub-module of Zoho Recruit. The Reviews sub-module acts as a bridge for associating Candidates, Job Openings, and Applications. Users can update reviews they own, with different permissions and limitations based on the type of submission (Recruiter, Candidate, or Interviewer). The API requires an OAuth token for authentication and accepts various parameters such as Review Comments, Rating, Assessment Name, and Interview Status. The response includes details of the modified record, including the time of modification and the user who modified it.
Input Fields: Input Fields
Output Fields: Output Fields

Update Tag

ID: put_update_tag
Operation: write
Entities: tag, module
Summary: The Update Tag API allows you to update a specific tag in the Zoho Recruit system. You need to provide the tag ID and the module API name as path and query parameters respectively. The request body should contain the new tag details including the name and optionally the color code. The API returns the updated tag details along with the status of the operation.
Input Fields: Input Fields
Output Fields: Output Fields