Guides
Signup For Free

Zoho People API Integration Vol.1

Suggest Edits

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

Add Announcement Comment API

  • ID: add_announcement_comment
  • Operation: write
  • Entities: comment, announcement
  • Summary: The Add Announcement Comment API allows users to add a comment to a specific announcement. The API requires an OAuth token for authorization, and the announcement ID and comment text as query parameters. The response includes the status and message of the operation, and if successful, details about the comment added. In case of an error, an error code and message are provided. The API has a threshold limit of 20 requests per minute, with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Case API

  • ID: add_case_api
  • Operation: write
  • Entities: case, category
  • Summary: The Add Case API is used to add new cases in the system. It requires an authentication token in the header and mandatory query parameters such as categoryId and subject. The description is optional. The API returns a success response with details of the created case, including the record ID and case ID, or an error response if the operation fails. The API has a threshold limit of 30 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Client API

  • ID: add_client_api
  • Operation: write
  • Entities: client, timetracker, billing method
  • Summary: The Add Client API is used to add a new client to the system. It requires the client name and currency as mandatory query parameters. Other optional parameters include billing method, email ID, first name, last name, phone number, mobile number, fax number, street address, city, state, pin code, country, industry, company size, and description. The API requires an Authorization header with a Zoho OAuth token. On success, it returns the client ID and a success message. In case of errors, it provides error codes and messages. The API has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Comments for Timer API

  • ID: add_comments_for_timer
  • Operation: write
  • Entities: timer, time log, comment
  • Summary: The Add Comments for Timer API allows users to add comments to a running timer. It requires the 'timeLogId' and 'comment' as mandatory query parameters. The request must include an 'Authorization' header with a valid Zoho OAuth token. The API returns a success message with the 'commentId' if the comment is added successfully. In case of an error, it returns an error message with a status code. The API has a threshold limit of 20 requests per minute, with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add File API

  • ID: add_file_api
  • Operation: write
  • Entities: employee, file, category
  • Summary: The Add File API allows users to add a file to the Zoho People system. It requires several query parameters including 'authtoken' for authentication, 'fileName' for the name of the file, 'filePath' for the file's location, 'fileDesc' for a description of the file, and 'fileType' to specify whether it is a Company or HR file. Additional parameters include 'confidential' to set file confidentiality, 'roleId', 'catId', 'employeeId', 'isreportingTo', 'notifyToall', 'locationId', and 'newCatName'. The API returns a response with a message, result containing category details, status, and URI.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Job Schedule API

  • ID: add_job_schedule
  • Operation: write
  • Entities: time tracker, job schedule, job
  • Summary: The Add Job Schedule API is used to add a new job schedule in Zoho People. It requires authorization via a Zoho OAuth token. The API accepts several query parameters including jobId, date, fromtime, totime, description, isPublish, assignedTo, isRepeat, repeatInterval, repeatType, repeatUntil, and skipMaxLogHrsValidation. The jobId, date, fromtime, and totime are mandatory parameters. The API returns a response containing the jobScheduleId of the newly added schedule, a success message, the URI of the API endpoint, and a status code. Error codes and messages are provided for various failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Time Logs API

  • ID: add_time_logs
  • Operation: write
  • Entities: user, time log, job
  • Summary: The Add Time Logs API allows users to add time logs for specific jobs and users in the Zoho People application. The API requires an OAuth token for authentication and accepts various query parameters such as user, jobId, workDate, and hours. The user parameter is mandatory and can be specified using ERECNO, Email-ID, or Employee-ID. The API supports additional parameters like projectId, projectName, jobName, billingStatus, and description. The response includes a timeLogId upon successful creation of a time log, along with a message and status code. Error handling is provided with specific error codes and messages for various failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Approve Timesheet API

  • ID: approve_timesheet
  • Operation: write
  • Entities: timesheet, time log, approval status
  • Summary: The Approve Timesheet API is used to approve a timesheet in the Zoho People application. It requires an authorization token in the header and several query parameters including 'timesheetId', 'approvalStatus', 'timeLogs', 'comments', and 'isAllLevelApprove'. The 'timesheetId' and 'approvalStatus' are mandatory parameters. The API returns a response indicating the success or failure of the operation, including the timesheet ID and a message. Error codes and messages are provided for various failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Change Job Status API

  • ID: change_job_status
  • Operation: write
  • Entities: project, status, job
  • Summary: The Change Job Status API is used to modify the status of a job in the Zoho People time tracker. It requires the job ID and the desired job status as query parameters. The API uses an OAuth token for authorization. The job status can be set to either 'In-Progress' or 'Completed'. The API returns a success message if the operation is successful, or an error message with a code if it fails. The API has a threshold limit of 20 requests per minute, with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Change Project Status API

  • ID: change_project_status
  • Operation: write
  • Entities: project, time tracker, status
  • Summary: The Change Project Status API is used to change the status of a project in Zoho People. It requires the project ID and the desired status as query parameters. The API uses Zoho OAuth token for authentication. The possible statuses are 'In-progress', 'Inprogress', or 'completed'. Upon successful execution, it returns a message indicating the project status was changed along with the project ID. In case of errors, it provides appropriate error messages and codes. The API has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Timesheets API

  • ID: create_timesheets
  • Operation: write
  • Entities: timesheet, user, time log
  • Summary: The Create Timesheets API is used to create new timesheets for a specified user in Zoho People. The API requires an authorization header with a Zoho OAuth token. The request parameters include mandatory fields such as 'user', 'timesheetName', 'fromDate', and 'toDate'. Optional parameters include 'description', 'dateFormat', 'billableStatus', 'jobId', 'projectId', 'clientId', and 'sendforApproval'. The API supports attaching a file to the timesheet by setting the content type to 'multipart/form-data'. The response includes a status, message, and an array of timesheet IDs if successful. Error codes and messages are provided for various failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Announcement Comment API

  • ID: delete_announcement_comment
  • Operation: write
  • Entities: comment, announcement
  • Summary: The Delete Announcement Comment API allows users to delete a specific comment from an announcement. The API requires an OAuth token for authorization, provided in the request header. The commentId, which is the ID of the comment to be deleted, must be included as a query parameter. The API returns a success message with the ID of the deleted comment if the operation is successful. In case of an error, such as insufficient permissions, an error message is returned. The API has a threshold limit of 20 requests per minute, with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Announcements API

  • ID: delete_announcements
  • Operation: write
  • Entities: response, request parameter, announcement
  • Summary: The Delete Announcements API allows users to delete a posted announcement by providing the announcement ID. The request requires an authorization token in the header and the announcement ID as a query parameter. The API has a threshold limit of 20 requests per minute and a lock period of 5 minutes. A successful response returns a status of 0 and a message of 'Success', while an error response returns a status of 1 and an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Assignment API

  • ID: delete_assignment_api
  • Operation: write
  • Entities: module, assignment, course
  • Summary: The Delete Assignment API is used to remove an assignment from a module within a course or batch in the LMS. It requires the course ID, module ID, and assignment ID as path parameters. For blended learning courses, a batch ID is also needed. The API uses a DELETE method and requires an Authorization header with a Zoho OAuth token. The response includes a status code, the ID of the deleted assignment, and the status of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Batch API

  • ID: delete_batch_api
  • Operation: write
  • Entities: batch, course
  • Summary: The Delete Batch API is used to delete a specific batch within a course in the Learning Management System (LMS). The API requires the course ID and batch ID as path parameters, and an authorization header with a valid Zoho OAuth token. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.DELETE for delete-only access. Upon successful deletion, the API returns a response with a code, message, and the ID of the deleted batch.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Batch Scheduler API

  • ID: delete_batch_scheduler
  • Operation: write
  • Entities: batch scheduler, authorization, course
  • Summary: The Delete Batch Scheduler API is used to delete a batch scheduler in the Learning Management System (LMS). The API requires the course ID and the batch scheduler ID as path parameters. The request must include an Authorization header with a valid Zoho OAuth token. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.DELETE for delete-only access. Upon successful deletion, the API returns a response with a code, the ID of the deleted scheduler, and a success message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Clients API

  • ID: delete_clients
  • Operation: write
  • Entities: time tracker, admin, client
  • Summary: The Delete Clients API is used to delete a list of clients by specifying their client IDs. The request requires an authorization header with a Zoho OAuth token and a query parameter 'clientId' which is a comma-separated list of client IDs to be deleted. The maximum number of IDs allowed is 1000. The API is permitted only for Admin users. A successful response returns a message indicating the clients were deleted successfully, while an error response includes an error code and message. The API has a threshold limit of 20 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Comment for Timer API

  • ID: delete_comment_for_timer
  • Operation: write
  • Entities: timer, comment
  • Summary: The Delete Comment for Timer API is used to delete existing comments associated with a timer in Zoho People. The API requires an OAuth token for authentication and a mandatory query parameter 'commentId' to specify which comment to delete. The API responds with a success message if the comment is deleted successfully, or an error message if there is an issue. The API has a threshold limit of 20 requests per minute, with a lock period of 5 minutes if the limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Course API

  • ID: delete_course
  • Operation: write
  • Entities: LMS, course
  • Summary: The Delete Course API is used to remove a course from the Learning Management System (LMS) by specifying the course ID in the URL path. The API requires an Authorization header with a valid Zoho OAuth token. The operation can be performed with either 'ZOHOPEOPLE.training.ALL' or 'ZOHOPEOPLE.training.DELETE' scopes. Upon successful deletion, the API returns a response with a code '200', a message 'success', and the ID of the deleted course.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Files API

  • ID: delete_files_api
  • Operation: write
  • Entities: file
  • Summary: The Delete Files API allows users to delete files from Zoho People by specifying the file ID(s) in the query parameters. The request requires an Authorization header with a valid Zoho OAuth token. Multiple file IDs can be provided to delete multiple files in a single request. The response includes a status and a message indicating the result of the delete operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Job Schedule API

  • ID: delete_job_schedule
  • Operation: write
  • Entities: repeat series, job schedule, error
  • Summary: The Delete Job Schedule API is used to delete job schedules in Zoho People. It requires the jobScheduleId as a mandatory query parameter to specify which job schedule to delete. Optionally, the isDeleteRepeat and delRepeatType parameters can be used to delete repeat series of schedules. The API requires an Authorization header with a Zoho OAuth token. The response includes the ID of the deleted job schedule and a success message. Error responses include error codes and messages. The API has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Jobs API

  • ID: delete_jobs
  • Operation: write
  • Entities: time tracker, job, api call
  • Summary: The Delete Jobs API is used to delete jobs in the Zoho People time tracker. It requires an OAuth token for authentication and a mandatory query parameter 'jobId' which specifies the job IDs to be deleted, separated by commas. The API supports two scopes: ZOHOPEOPLE.timetracker.ALL for complete access and ZOHOPEOPLE.timetracker.DELETE for delete-only access. The API returns a success message if the jobs are deleted successfully, or an error message with a code if the operation fails. The API has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Link API

  • ID: delete_link
  • Operation: write
  • Entities: module, course, link
  • Summary: The Delete Link API is used to delete a link within a module of a course or batch in the LMS. It requires the course ID, module ID, and link ID as path parameters. For blended learning courses, a batch ID is also required. The API uses the DELETE method and requires an Authorization header with a Zoho OAuth token. The response includes the ID of the deleted link, a response code, and the status of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Modules API

  • ID: delete_modules_api
  • Operation: write
  • Entities: module, batch, course
  • Summary: The Delete Modules API is used to delete a module from courses or batches in the LMS. It requires the course ID and module ID as path parameters, and optionally a batch ID for blended learning courses. The request must include an Authorization header with a valid Zoho OAuth token. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.DELETE for delete-only access. Upon successful deletion, the API returns a response with a status code of 200, the module ID, and a success status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Offline Test API

  • ID: delete_offline_test
  • Operation: write
  • Entities: module, course, offline test
  • Summary: The Delete Offline Test API is used to delete an offline test from a module within a course or batch in the LMS. The API requires the course ID, module ID, and offline test ID as path parameters. For blended learning courses, a batch ID is also required. The request must include an Authorization header with a valid Zoho OAuth token. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.DELETE for delete-only access. Upon successful deletion, the API returns a response with a code of 200, the ID of the deleted offline test, and a status of 'success'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Online Test API

  • ID: delete_online_test
  • Operation: write
  • Entities: module, online test, course
  • Summary: The Delete Online Test API is used to delete an online test from a module within a course or batch in the LMS. The API requires the course ID, module ID, and online test ID as path parameters. For blended learning courses, a batch ID is also required. The request must include an Authorization header with a valid Zoho OAuth token. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.DELETE for delete-only access. Upon successful deletion, the API returns a response with a code of 200, the ID of the deleted test, and a status of 'success'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Post Learning Activity - Online Test

  • ID: delete_post_learning_activity_online_test
  • Operation: write
  • Entities: online test, course, learning activity
  • Summary: This API is used to delete an online test that is part of a post learning activity in the LMS. The request requires the course ID and the test ID as path parameters, and an authorization token in the header. The response includes a status code, the ID of the deleted test, and a success message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Pre Learning Activity - Online Test

  • ID: delete_pre_learning_activity_online_test
  • Operation: write
  • Entities: online test, course, pre learning activity
  • Summary: This API is used to delete an online test from pre-learning activities in a specified course. The request requires the course ID and the test ID as path parameters, and an authorization header with a Zoho OAuth token. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.DELETE for delete-only access. Upon successful deletion, the API returns a response with a code, the test ID, and a success message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Projects API

  • ID: delete_projects
  • Operation: write
  • Entities: project, time tracker, api request
  • Summary: The Delete Projects API is used to delete projects in Zoho People. It requires an OAuth token for authentication and a mandatory query parameter 'projectId' which specifies the project IDs to be deleted, separated by commas (maximum 1000 IDs). The API returns a success message with the deleted project IDs or an error message with error codes if the deletion fails. The API has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Remove Learner From Batch API

  • ID: delete_remove_learner_from_batch
  • Operation: write
  • Entities: learner, batch, course
  • Summary: The Remove Learner From Batch API is used to remove a learner from a specific batch in the Learning Management System (LMS). The API requires the course ID, batch ID, and learner ID as path parameters. The request must include an Authorization header with a valid Zoho OAuth token. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.DELETE for delete operations only. Upon successful execution, the API returns a response with a code, the learner ID that was removed, and a success message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Remove Learner From Course API

  • ID: delete_remove_learner_from_course
  • Operation: write
  • Entities: learner, LMS, course
  • Summary: The Remove Learner From Course API is used to remove a learner from a specified course in the Learning Management System (LMS). The API requires the course ID and learner ID as path parameters. It uses the DELETE method and requires an Authorization header with a valid Zoho OAuth token and a Scope header indicating the level of access, either ZOHOPEOPLE.training.ALL for complete access or ZOHOPEOPLE.training.DELETE for delete-only access. The response includes a status and message indicating the result of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Remove Shared Course API

  • ID: delete_remove_shared_course
  • Operation: write
  • Entities: shared user, course
  • Summary: The Remove Shared Course API is used to remove a shared user from a course in the LMS. It requires the course ID as a path parameter and the employee erecno of the user to be removed as a query parameter. The request must include an Authorization header with a valid Zoho OAuth token. The API supports DELETE operations and requires the appropriate scope for authorization. Upon successful execution, it returns a response with a code, the erecno of the removed user, a success message, and the course ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Session API

  • ID: delete_session_api
  • Operation: write
  • Entities: module, batch, session
  • Summary: The Delete Session API is used to delete a session within a module of a batch in the Learning Management System (LMS). The API requires the course ID, batch ID, module ID, and session ID as path parameters to identify the specific session to be deleted. The request must include an Authorization header with a valid Zoho OAuth token. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.DELETE for delete-only access. Upon successful deletion, the API returns a response with a code of 200, the session ID, and a status of 'success'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Time Logs API

  • ID: delete_time_logs
  • Operation: write
  • Entities: time log
  • Summary: The Delete Time Logs API is used to delete unwanted time logs from the Zoho People Time Tracker. It requires an OAuth token for authentication and accepts a mandatory query parameter 'timeLogId', which specifies the IDs of the time logs to be deleted, separated by commas. The maximum number of IDs allowed is 1000. The API returns a success message with the status code 0 if the deletion is successful. In case of an error, it returns an error message with a status code of 1. The API has a threshold limit of 20 requests per minute, with a lock period of 5 minutes before consecutive requests can be made.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Timesheets API

  • ID: delete_timesheets
  • Operation: write
  • Entities: timesheet, error code, response
  • Summary: The Delete Timesheets API is used to delete specified timesheets in Zoho People. The API requires an OAuth token for authorization and a mandatory query parameter 'timesheetId' which is a comma-separated list of timesheet IDs to be deleted. The maximum number of IDs allowed is 1000. The API returns a response indicating the IDs that were successfully deleted and any that were not, along with error codes and messages. The API has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Trainer API

  • ID: delete_trainer
  • Operation: write
  • Entities: LMS, authorization, trainer
  • Summary: The Delete Trainer API is used to remove a trainer from the LMS. It requires the trainer's unique identifier as a path parameter and an authorization token in the header. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.DELETE for delete-only access. Upon successful deletion, it returns a response with a code, message, and the trainerId of the deleted trainer.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Announcements API

  • ID: edit_announcements
  • Operation: write
  • Entities: location, email, announcement
  • Summary: The Update Announcements API allows users to edit an already posted announcement. It requires an authorization token in the header. The request parameters include the ID of the announcement, subject, message, expiry date, location, email list, notification preference, sticky status, and comment disable status. The response includes the status, message, and details of the updated announcement. The API has a threshold limit of 10 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Edit File API

  • ID: edit_file_api
  • Operation: write
  • Entities: employee, location, file
  • Summary: The Edit File API allows users to edit the details of a file in the Zoho People system. The API requires several query parameters including fileName, filePath, fileDesc, fileType, confidential, roleId, catId, employeeId, isreportingTo, notifyToall, locationId, newCatName, and fileId. The request must include an Authorization header with a valid Zoho OAuth token. The response indicates the success of the operation and returns the ID of the edited file.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Edit Job Schedule API

  • ID: edit_job_schedule_api
  • Operation: write
  • Entities: job schedule, job, date
  • Summary: The Edit Job Schedule API allows users to modify existing job schedules in Zoho People. The API requires an OAuth token for authentication and accepts various query parameters to specify the details of the job schedule to be edited, such as jobScheduleId, jobId, date, fromtime, totime, description, and more. The API supports repeating schedules and allows for editing repeat series with options like isEditRepeat and editRepeatType. The response includes the edited jobScheduleId and a success message. Error codes are provided for handling issues such as permission denial and invalid parameters.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Modify Time Logs API

  • ID: edit_time_logs
  • Operation: write
  • Entities: user, time log, job
  • Summary: The Modify Time Logs API allows users to edit specific time logs in the Zoho People system. The API requires an OAuth token for authorization and accepts various query parameters to specify the details of the time log to be modified, such as timeLogId, user, jobId, workDate, billingStatus, hours, fromTime, toTime, workItem, and description. The API returns a response indicating the success or failure of the operation, along with the modified time log ID. Error codes and messages are provided for various failure scenarios, such as incorrect parameter formats or permission issues. The API has a threshold limit of 20 requests per minute, with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Bradford Report for Rolling 12 Months

  • ID: fetch_bradford_report_for_rolling_12_months
  • Operation: read
  • Entities: report, employee, bradford score
  • Summary: This API fetches the Bradford report for a rolling 12-month period from the specified 'asOn' date. It requires an authorization header with a Zoho OAuth token. The API accepts query parameters 'employee', a JSONArray of Erecnos numbers of users (maximum 30), and 'asOn', a date string representing the report till date, defaulting to the current date. The response includes the Bradford score and employee details. The API has a threshold limit of 30 requests per minute and a lock period of 2 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Last Attendance Entries API

  • ID: fetch_last_attendance_entries
  • Operation: read
  • Entities: attendance entry, employee, regularisation entry
  • Summary: The Fetch Last Attendance Entries API retrieves the latest attendance entries, including regularisation entries, that have been added or updated within a specified duration in minutes. This API is accessible only by admin and data admin users. The request requires an OAuth token for authorization and accepts query parameters for the duration and date-time format. The response includes details of single and multi regularisation entries, as well as attendance entries added through other means. The API has a threshold limit of 30 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record API

  • ID: fetch_single_record
  • Operation: read
  • Entities: employee, leave, department
  • Summary: The Fetch Single Record API retrieves a leave record from the indexed database using a specified Record ID. The API requires an authorization header with a Zoho OAuth token and a query parameter 'recordId' to specify the leave record to be fetched. The response includes detailed information about the leave, such as Employee ID, Day Details, Leave Type, Approval Status, and more. The API has a threshold limit of 400 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Filter Announcements API

  • ID: filter_announcements
  • Operation: read
  • Entities: owner, location, announcement
  • Summary: The Filter Announcements API allows users to filter announcements based on various parameters such as isSticky, location, enable, and startIdx. The API requires an authorization header with a Zoho OAuth token. The query parameters include isSticky to filter sticky announcements, location to filter by location, enable to filter enabled or disabled announcements, and startIdx for pagination. The response includes a list of announcements with details such as owner, modified time, subject, and more, along with like and comment counts.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Announcements API

  • ID: get_all_announcements
  • Operation: read
  • Entities: owner, comment, announcement
  • Summary: The Get All Announcements API is used to list all announcements. It requires an authorization header with a Zoho OAuth token. The API accepts query parameters such as 'isSticky' to filter sticky announcements, 'startIdx' to specify the starting index for fetching records, and 'search' to search for a keyword within the records. The response includes a list of announcements with details such as owner, modified time, subject, and message. It also provides information on whether there are more announcements to fetch and the count of comments for each announcement.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Holidays API

  • ID: get_all_holidays
  • Operation: read
  • Entities: location, holiday, shift
  • Summary: The Get All Holidays API is used to fetch the holidays for a specified location, shift, or employee. It accepts optional query parameters such as location, shift, employee, upcoming, from, to, and dateFormat to filter the holidays. If no parameters are provided, it defaults to fetching the current leave year's holidays for the logged-in user. The response includes details about each holiday, such as whether it is restricted, the shift name, remarks, location ID, shift ID, holiday ID, date, whether it is a half-day, holiday name, location name, and session. The API has a threshold limit of 30 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Attendance Check-in and Check-out API

  • ID: get_attendance_check_in_and_check_out
  • Operation: write
  • Entities: employee, attendance, check-in
  • Summary: The Attendance Check-in and Check-out API is used to capture the check-in and check-out entries of individual employees. It updates the attendance status in the web portal for every check-in and check-out. The API requires a Zoho OAuth token for authorization and accepts query parameters such as dateFormat, checkIn, checkOut, empId, emailId, and mapId. At least one of empId, emailId, or mapId must be provided to map the entry of an employee. The API returns a response indicating the success or failure of the attendance recording. It is ideal for minimal entries, with a threshold limit of 100 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Attendance Entries API

  • ID: get_attendance_entries
  • Operation: read
  • Entities: attendance entry, employee, request parameter
  • Summary: The Attendance Entries API is used to retrieve the attendance entries of employees. It requires an authorization header with a Zoho OAuth token. The API accepts optional query parameters such as date, dateFormat, erecno, mapId, emailId, and empId to filter the attendance data. If no specific employee identifier is provided, the API will return the attendance details of the logged-in user. The response includes details such as first check-in time, total hours worked, individual attendance entries with check-in and check-out details, and the attendance status. The API has a threshold limit of 100 requests per minute with a lock period of 10 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Batch Scheduler API

  • ID: get_batch_scheduler
  • Operation: read
  • Entities: batch, scheduler, course
  • Summary: The Fetch Batch Scheduler API is used to retrieve a batch scheduler in the Learning Management System (LMS). The API requires the course ID and batch scheduler ID as path parameters and an authorization token in the header. It returns a list of batch schedulers with details such as the number of batches created, scheduler name, scheduler ID, course ID, and locations. The response includes a status code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Batch Scheduler List API

  • ID: get_batch_scheduler_list
  • Operation: read
  • Entities: batch scheduler, location, course
  • Summary: The Fetch Batch Scheduler List API is used to retrieve a list of batch schedulers for a specific course in the Learning Management System (LMS). The API requires an OAuth token for authorization and accepts a courseId as a path parameter to specify the course. An optional query parameter, startIndex, can be used to indicate the starting record for the response. The response includes detailed information about the batch scheduler, such as batch name, frequency, capacity, and scheduling details, along with a response code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records API

  • ID: get_bulk_records
  • Operation: read
  • Entities: form, employee, record
  • Summary: The Get Bulk Records API is used to fetch bulk records along with their tabular section details from specified forms. The API allows fetching up to 200 records per call. It requires an OAuth token for authorization and supports various query parameters such as 'sIndex' for the starting index, 'limit' for the number of records, 'searchColumn' and 'searchValue' for searching specific records, and 'modifiedtime' for fetching records modified after a certain timestamp. The response includes detailed information about each record, including personal and employment details, and tabular sections like education and work experience.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records API

  • ID: get_bulk_records_api
  • Operation: read
  • Entities:
  • Summary: This API is used to fetch the list of all the employees in the app. The API allows fetching up to 200 records per call. It requires an OAuth token for authorization and supports various query parameters such as 'sIndex' for the starting index, 'limit' for the number of records, 'searchColumn' and 'searchValue' for searching specific records, and 'modifiedtime' for fetching records modified after a certain timestamp. The response includes detailed information about each record, including personal and employment details, and tabular sections like education and work experience.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records of AddressProof

  • ID: get_bulk_records_of_addressproof
  • Operation: read
  • Entities: employee, address proof, request
  • Summary: The Get Bulk Records of AddressProof API is used to fetch bulk records from the AddressProof form in Zoho People. It allows fetching up to 200 records per API call, starting from a specified index. The API requires an OAuth token for authentication and supports optional query parameters for searching by employee ID or email alias, and filtering by modification time. The response includes detailed information about each record, such as request date, employee ID, reason for request, and approval status. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes between consecutive requests.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records of BonafideLetter

  • ID: get_bulk_records_of_bonafideletter
  • Operation: read
  • Entities: bonafide letter, employee, request
  • Summary: The Get Bulk Records of BonafideLetter API is used to fetch bulk records along with their tabular section details from the BonafideLetter form. The API allows fetching a maximum of 200 records per call. It requires an OAuth token for authentication and supports optional query parameters such as SearchColumn, SearchValue, and modifiedtime to filter the records. The response includes the list of records with details such as Date_of_Request, CreatedTime, ModifiedTime, Zoho_ID, and more. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records of Department

  • ID: get_bulk_records_of_department
  • Operation: read
  • Entities: designation, employee, department
  • Summary: The Get Bulk Records of Department API is used to fetch bulk records from the department form in Zoho People. It allows fetching up to 200 records per API call, starting from a specified index. The API requires an OAuth token for authentication and supports optional search parameters for filtering records by employee ID or email alias, as well as fetching records modified after a certain timestamp. The response includes detailed information about each record, such as designation, modification details, and approval status. The API has a threshold limit of 400 requests per minute, with a lock period of 5 minutes between consecutive requests.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records of Designation

  • ID: get_bulk_records_of_designation
  • Operation: read
  • Entities: form, designation, record
  • Summary: This API is used to fetch bulk records of designations from Zoho People. It allows fetching up to 200 records per API call, starting from a specified index. The API requires an OAuth token for authentication and supports optional search parameters such as SearchColumn, SearchValue, and modifiedtime to filter the results. The response includes detailed information about each designation, such as the designation title, creation and modification timestamps, and user details who added or modified the record. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records of Exit Interview

  • ID: get_bulk_records_of_exit_interview
  • Operation: read
  • Entities: exit interview, employee, record
  • Summary: The 'Get Bulk Records of Exit Interview' API is used to fetch bulk records from the exit interview forms in Zoho People. It allows fetching up to 200 records per API call. The API requires an OAuth token for authentication and supports query parameters such as 'sIndex' for the starting index of records, 'limit' for the number of records to fetch, 'SearchColumn' and 'SearchValue' for filtering records, and 'modifiedtime' for fetching records modified after a specific timestamp. The response includes detailed information about each record, such as employee details, interview information, and timestamps.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records of ExperienceLetter

  • ID: get_bulk_records_of_experienceletter
  • Operation: read
  • Entities: employee, experience letter, request
  • Summary: The Get Bulk Records of ExperienceLetter API is used to fetch bulk records from the ExperienceLetter form in Zoho People. It allows fetching up to 200 records per API call, starting from a specified index. The API requires an OAuth token for authentication and supports optional search parameters such as SearchColumn, SearchValue, and modifiedtime to filter the records. The response includes detailed information about each record, including the date of request, employee ID, reason for request, and approval status. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records of Leave

  • ID: get_bulk_records_of_leave
  • Operation: read
  • Entities: employee, record, leave
  • Summary: The 'Get Bulk Records of Leave' API is used to fetch multiple leave records from the Zoho People platform. It allows users to retrieve up to 200 records per API call, starting from a specified index. The API requires an OAuth token for authentication and supports optional search parameters such as employee ID or email alias, and a modified time filter. The response includes detailed information about each leave record, including creation and modification times, employee details, leave type, and approval status. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes between consecutive requests.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records of P_ClientDetails

  • ID: get_bulk_records_of_p_clientdetails
  • Operation: read
  • Entities: form, client detail, record
  • Summary: This API is used to fetch bulk records from the P_ClientDetails form in Zoho People. It allows fetching up to 200 records per API call, starting from a specified index. The API requires an OAuth token for authentication and supports optional query parameters for searching by employee ID or email alias, and filtering by modification time. The response includes detailed information about each client record, such as client name, address, contact details, and other metadata. The API has a threshold limit of 400 requests per minute, with a lock period of 5 minutes between consecutive requests.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records of P_Task

  • ID: get_bulk_records_of_p_task
  • Operation: read
  • Entities: form, task, record
  • Summary: The 'Get Bulk Records of P_Task' API is used to fetch multiple records from the P_Task form in Zoho People. It allows fetching up to 200 records per API call, starting from a specified index. The API requires an OAuth token for authentication and supports optional search parameters such as SearchColumn, SearchValue, and modifiedtime to filter the records. The response includes detailed information about each task, such as status, description, priority, task owner, and dates. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes between consecutive requests.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records of P_TimesheetJob

  • ID: get_bulk_records_of_p_timesheetjob
  • Operation: read
  • Entities: timesheet, project, job
  • Summary: The 'Get Bulk Records of P_TimesheetJob' API is used to fetch bulk records from the P_TimesheetJob form in Zoho People. It allows fetching up to 200 records per API call, starting from a specified index. The API requires an OAuth token for authentication and supports optional search parameters such as SearchColumn, SearchValue, and modifiedtime to filter the records. The response includes detailed information about each record, such as job name, hours, rate per hour, job owner, and more. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records of P_TimesheetJobsList

  • ID: get_bulk_records_of_p_timesheetjobslist
  • Operation: read
  • Entities: project, employee, timesheet job
  • Summary: The 'Get Bulk Records of P_TimesheetJobsList' API is used to fetch bulk records from the P_TimesheetJobsList form in Zoho People. It allows fetching up to 200 records per API call, starting from a specified index. The API requires an OAuth token for authentication and supports optional search parameters such as SearchColumn, SearchValue, and modifiedtime to filter the records. The response includes detailed information about each record, including project details, status, and timestamps. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes between consecutive requests.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records of Travel Expenses

  • ID: get_bulk_records_of_travel_expenses
  • Operation: read
  • Entities: employee, record, travel expense
  • Summary: The 'Get Bulk Records of Travel Expenses' API is used to fetch multiple travel expense records from Zoho People. It allows fetching up to 200 records per call, including details from tabular sections. The API requires an OAuth token for authentication and supports optional query parameters for filtering results by employee ID, email alias, or modification time. The response includes detailed information about each record, such as creation and modification times, employee details, and approval status. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes between consecutive requests.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records of Travel Request

  • ID: get_bulk_records_of_travel_request
  • Operation: read
  • Entities: employee, travel request, department
  • Summary: This API is used to fetch bulk records of travel requests from the Zoho People platform. It allows fetching up to 200 records per API call, starting from a specified index. The API requires an OAuth token for authentication and supports optional search parameters such as SearchColumn, SearchValue, and modifiedtime to filter the records. The response includes detailed information about each travel request, such as TravelID, EmployeeID, ApprovalStatus, and more. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Client Details API

  • ID: get_client_details
  • Operation: read
  • Entities: company, client, contact
  • Summary: The Get Client Details API is used to retrieve details of a specific client using their client ID. The API requires an Authorization header with a Zoho OAuth token. The clientId is a mandatory query parameter, while fetchRecPerm is optional and indicates if delete permission for the record should be fetched. The API returns a detailed response including client information such as name, contact details, address, industry, and more. The response also indicates if the client record can be deleted. The API is restricted to Admin users and has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Clients API

  • ID: get_clients_api
  • Operation: read
  • Entities: client, address, industry
  • Summary: The Get Clients API is used to retrieve a list of clients from the Zoho People Time Tracker. It requires an OAuth token for authentication and supports optional query parameters 'sIndex' and 'limit' to specify the starting index and the number of records to fetch, respectively. The API returns a list of client details including client ID, name, contact information, and other relevant details. The response also indicates if more data is available. This API is accessible only to Admin users and has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Comments for Timer API

  • ID: get_comments_for_timer
  • Operation: read
  • Entities: timer, time log, comment
  • Summary: The Get Comments for Timer API is used to retrieve comments associated with a running timer. It requires a mandatory query parameter 'timeLogId' to specify the timer log ID. The request must include an 'Authorization' header with a valid Zoho OAuth token. The API returns a list of comments with details such as comment ID, creation time, and the comment text. In case of an error, it provides an error message and code. The API has a threshold limit of 20 requests per minute, with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Course Batch List API

  • ID: get_course_batch_list
  • Operation: read
  • Entities: learner, batch, course
  • Summary: The Fetch Course Batch List API is used to retrieve a list of batches for a specific course in the Learning Management System (LMS). The API requires an OAuth token for authorization and the course ID as a path parameter. Optionally, a startIndex query parameter can be provided to specify the starting record for the response. The response includes details about each batch, such as the number of learners, start and end dates, batch name, capacity, and publish status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Course Batch Sessions API

  • ID: get_course_batch_sessions
  • Operation: read
  • Entities: batch, course, session
  • Summary: The Fetch Course Batch Sessions API is used to retrieve sessions within a specific course batch in the Learning Management System (LMS). The API requires the course ID and batch ID as path parameters and supports an optional query parameter 'startIndex' to specify the starting record for fetching sessions. The request must include an Authorization header with a valid Zoho OAuth token. The response includes details of each session such as session name, start and end times, description, room, trainer, and other attributes. The API returns a list of sessions along with a response code and message indicating success or failure.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Course Modules API

  • ID: get_course_modules
  • Operation: read
  • Entities: module, batch, course
  • Summary: The Fetch Course Modules API is used to retrieve modules within courses or batches in a Learning Management System (LMS). The API supports two types of courses: Self Paced and Blended Learning. For Self Paced courses, the endpoint is '/courses//modules', and for Blended Learning courses, it is '/courses//batches//modules'. The API requires an Authorization header with a Zoho OAuth token. It supports an optional query parameter 'startIndex' to specify the starting record for fetching. The response includes a list of modules with details such as duration, lock status, module name, and associated entity data. The response also indicates if there are more records to fetch with the 'hasMoreRecords' flag.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Course or Batch Contents API

  • ID: get_course_or_batch_contents
  • Operation: read
  • Entities: course, batch, content
  • Summary: The Fetch Course or Batch Contents API is used to retrieve the contents of courses or batches in the LMS. It supports two types of courses: Self Paced Learning and Blended Learning. The API requires an OAuth token for authentication and can be accessed with either full access (ALL) or read-only access (READ). The request URL varies based on the type of course, and the API supports fetching up to 25 records in a single call. The response includes details about each content item, such as its ID, description, resources, and status flags.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Course or Batch Files API

  • ID: get_course_or_batch_files
  • Operation: read
  • Entities: file, batch, course
  • Summary: The Fetch Course or Batch Files API is used to retrieve files associated with a specific course or batch in the Learning Management System (LMS). The API supports two types of courses: Self Paced and Blended Learning. For Self Paced courses, the endpoint is '/courses//files', and for Blended Learning courses, it is '/courses//batches//files'. The API requires an Authorization header with a Zoho OAuth token. It accepts an optional query parameter 'startIndex' to specify the starting record for fetching files, with a default value of 0. The response includes a list of files with details such as file name, preview URL, description, and associated resources. The response also indicates if there are more records to fetch.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Course or Batch Links API

  • ID: get_course_or_batch_links
  • Operation: read
  • Entities: batch, course, link
  • Summary: The Fetch Course or Batch Links API is used to retrieve links associated with courses or batches in the LMS. It requires an OAuth token for authorization and supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.READ for read-only access. The API supports fetching links for both self-paced courses and Blender Learning courses, with the option to specify a batch ID for the latter. The response includes details about each link, such as its ID, lock status, URL, description, associated resources, and permissions for editing or deleting.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Course or Batch Offline Tests API

  • ID: get_course_or_batch_offline_tests
  • Operation: read
  • Entities: batch, course, offline test
  • Summary: The Fetch Course or Batch Offline Tests API is used to retrieve offline tests associated with a specific course or batch in the Learning Management System (LMS). The API supports two types of courses: Self Paced and Blended Learning. For Self Paced courses, the endpoint is '/courses//offlineTests', and for Blended Learning courses, it is '/courses//batches//offlineTests'. The API requires an Authorization header with a Zoho OAuth token. It accepts an optional query parameter 'startIndex' to specify the starting record for fetching results, with a default value of 0. The response includes a list of offline tests with details such as test description, resources, duration, and other attributes. The response also indicates if there are more records to fetch.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Course Settings API

  • ID: get_course_settings
  • Operation: read
  • Entities: activity, course, setting
  • Summary: The Fetch Course Settings API is used to retrieve the settings of a specific course in the LMS. The API requires an OAuth token for authorization and the course ID as a path parameter. It returns detailed information about the course settings, including post-course activities, grading settings, permissions, and pre-course activities. The response includes the status and configuration of these settings, such as whether activities are mandatory, grading types allowed, and roles that can enroll or unenroll.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Currently Running Timer API

  • ID: get_currently_running_timer
  • Operation: read
  • Entities: timer, employee, job
  • Summary: The Get Currently Running Timer API is used to retrieve details of the currently running timer for a user. The API requires an Authorization header with a Zoho OAuth token. It accepts an optional query parameter 'dateFormat' to specify the format of the date. The response includes details such as job name, current time, hours, billing status, timer ID, job ID, work date, total time logged, and employee name. The API returns a message indicating the success of the operation and the status of the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Default And Custom View API

  • ID: get_default_and_custom_view
  • Operation: read
  • Entities: form, record, view
  • Summary: The Default And Custom View API provides a list of view details available in all forms. It allows users to retrieve both default and custom views for forms such as Employee, Department, and Designation. The API requires an Authorization header with a Zoho OAuth token. The response includes an array of objects, each containing view details like viewName, displayName, and viewId for different categories such as P_Employee, P_Department, and P_Designation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Related Files

  • ID: get_documents_for_employee
  • Operation: read
  • Entities:
  • Summary: The Get Employee Related Files API allows users to retrieve files related to a specific employee from Zoho People. It requires an authorization header with a Zoho OAuth token. The query parameters include fileType (1 for Company Files, 0 for HR Files), start and limit for pagination, and optional parameters such as roleId, catId, employeeId, locationId, and filterBy. The response includes details about the files such as fileOwnerName, fileName, fileCatName, filePath, and more, along with a message and status indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Download Files API

  • ID: get_download_files
  • Operation: read
  • Entities: file
  • Summary: The Download Files API allows users to download a file from Zoho People by specifying the file ID. The request requires an OAuth token for authorization, which should be included in the headers. The fileId query parameter is mandatory and specifies the file to be downloaded. The response includes headers indicating the content type and disposition, and the body contains the binary content of the file.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Related Files

  • ID: get_employee_related_files
  • Operation: read
  • Entities:
  • Summary: The Get Employee Related Files API allows users to retrieve files related to a specific employee from Zoho People. It requires an authorization header with a Zoho OAuth token. The query parameters include fileType (1 for Company Files, 0 for HR Files), start and limit for pagination, and optional parameters such as roleId, catId, employeeId, locationId, and filterBy. The response includes details about the files such as fileOwnerName, fileName, fileCatName, filePath, and more, along with a message and status indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Encashment Report API

  • ID: get_encashment_report
  • Operation: read
  • Entities: employee, encashment report, pay period
  • Summary: The Encashment Report API retrieves the encashment report for a specified pay cycle. It requires the payPeriodSettingId, from, and to parameters to specify the pay cycle. Optional parameters include employee, unit, startIndex, and limit. The response includes encashment details for each employee within the specified pay cycle, including the encashment amount and employee information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch All Courses in LMS

  • ID: get_fetch_all_courses_in_lms
  • Operation: read
  • Entities: trainer, course, category
  • Summary: The Fetch All Courses in LMS API allows users to retrieve information about all courses available in the Learning Management System (LMS). The API requires an authorization header with a Zoho OAuth token. It supports various query parameters such as startIndex, search, type, categoryId, trainerId, state, sortBy, startDate, endDate, sharedToMe, and suggestedToMe to filter and sort the courses. The response includes a list of courses with details such as course type, status, user roles, and more. The API returns a JSON response with a list of courses, response code, message, and a flag indicating if there are more records to fetch.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Categories API

  • ID: get_fetch_categories
  • Operation: read
  • Entities: request parameter, response code, category
  • Summary: The Fetch Categories API is used to retrieve a list of categories from the Learning Management System (LMS). The API requires an Authorization header with a Zoho OAuth token for authentication. It supports a query parameter 'startIndex' to specify the starting point for fetching records, with a default value of 0. The response includes a list of categories, each with a name, a boolean indicating if it is a favourite, and a unique category ID. The response also includes a message and a boolean indicating if there are more records to fetch.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Forms API

  • ID: get_fetch_forms
  • Operation: read
  • Entities: component, authorization, form
  • Summary: The Fetch Forms API is used to retrieve a list of forms and their details available in your Zoho People account. The API requires an Authorization header with a Zoho OAuth token. It supports two scopes: ZOHOPEOPLE.forms.ALL for complete access and ZOHOPEOPLE.form.READ for read-only access. The response includes details such as visibility, display name, component ID, custom status, and form link name for each form. The API has a threshold limit of 30 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Module Content API

  • ID: get_fetch_module_content
  • Operation: read
  • Entities: course, module, content
  • Summary: The Fetch Module Content API is used to retrieve contents within modules of courses or batches in the LMS. It supports both Self Paced and Blended Learning Courses. The API requires an Authorization header with a Zoho OAuth token. The request URL varies slightly depending on the course type, with an optional batchId path parameter for Blended Learning Courses. The API supports a query parameter 'startIndex' to specify the starting record for the response, with a default value of 0. The response includes a list of contents with details such as content ID, description, resources, and more. The API returns a status code, a message, and a flag indicating if more records are available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Module Files API

  • ID: get_fetch_module_files
  • Operation: read
  • Entities: file, course, module
  • Summary: The Fetch Module Files API is used to retrieve files within modules of courses or batches in the LMS. It supports both self-paced and blended learning courses. The API requires an OAuth token for authorization and can be accessed with either complete or read-only permissions. The request URL varies slightly depending on the course type, and it accepts a 'startIndex' query parameter to specify the starting record for fetching. The response includes details about each file, such as its name, preview URL, description, and associated resources. The API returns a success message and indicates if there are more records to fetch.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Module Online Tests API

  • ID: get_fetch_module_online_tests
  • Operation: read
  • Entities: module, online test, course
  • Summary: The Fetch Module Online Tests API is used to retrieve online tests within modules of courses or batches in a Learning Management System (LMS). The API supports two types of courses: Self-Paced and Blended Learning. The endpoint requires a courseId and moduleId as path parameters, and optionally a batchId for Blended Learning courses. The API uses a GET method and requires an Authorization header with a Zoho OAuth token. The query parameter startIndex can be used to specify the starting record for the response, with a default value of 0. The response includes a list of online tests with details such as preview URL, test duration, status, and more. The API returns a response code, a message, and a flag indicating if more records are available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch My Courses API

  • ID: get_fetch_my_courses
  • Operation: read
  • Entities: trainer, course, category
  • Summary: The Fetch My Courses API is used to retrieve all the courses that a user has joined. It requires an authorization header with a Zoho OAuth token. The API supports various query parameters such as startIndex, search, type, categoryId, trainerId, state, sortBy, startDate, endDate, sharedToMe, and suggestedToMe to filter and sort the courses. The response includes a list of courses with details such as course type, status, user roles, and more. The API provides complete or read-only access based on the scope provided in the authorization token.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Record API

  • ID: get_fetch_record
  • Operation: read
  • Entities: form, employee, record
  • Summary: The Fetch Record API is used to retrieve all records from a specified form view in Zoho People. The API allows filtering records based on predefined columns such as EMPLOYEEID or EMPLOYEEMAILALIAS, and can also fetch records modified after a certain timestamp. The request requires an OAuth token for authorization and accepts parameters like viewname, sIndex, rec_limit, searchColumn, searchValue, and modifiedtime. The response includes detailed information about each record, such as EmployeeID, EmployeeRole, createdTime, modifiedTime, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Rooms API

  • ID: get_fetch_rooms
  • Operation: read
  • Entities: facility, location, room
  • Summary: The Fetch Rooms API is used to retrieve a list of rooms available in the LMS. It requires an authorization header with a Zoho OAuth token. The API supports a query parameter 'startIndex' to specify the starting point of records to fetch, with a default value of 0. The response includes details of rooms such as name, location, facilities, room ID, and capacity. The response also contains a code and message indicating the success of the operation, and a boolean 'hasMoreRecords' to indicate if more records are available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Settings API

  • ID: get_fetch_settings
  • Operation: read
  • Entities: feature policy, grading, setting
  • Summary: The Fetch Settings API is used to retrieve the settings for the Learning Management System (LMS) in Zoho People. It requires an OAuth token for authentication, which should be included in the Authorization header. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.READ for read-only access. The response includes various settings such as general settings (e.g., course URL sharing and notifications), grading settings (e.g., grading types and grade ranges), and feature policies (e.g., who can start discussions and give feedback). The response is returned in JSON format with a success message and code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single File API

  • ID: get_fetch_single_file
  • Operation: read
  • Entities: file, course, module
  • Summary: The Fetch Single File API is used to retrieve details of a specific file within a module of a course in the LMS. It supports both Self-Paced and Blended Learning courses. The API requires an OAuth token for authorization and accepts path parameters including courseId, moduleId, and fileId. For Blended Learning courses, an additional batchId parameter is required. The response includes detailed information about the file, such as its name, preview URL, description, resources, and various permissions and attributes related to the file.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Link API

  • ID: get_fetch_single_link
  • Operation: read
  • Entities: module, course, link
  • Summary: The Fetch Single Link API is used to retrieve details of a specific link within a module of a course in the LMS. The API requires the courseId, moduleId, and linkId as path parameters, and an Authorization header with a Zoho OAuth token. The response includes details about the link such as its lock status, whether it is mandatory, its URL, description, associated resources, and permissions for the user to edit or delete the link.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Fields of Form API

  • ID: get_fields_of_form
  • Operation: read
  • Entities: component, form
  • Summary: The Get Fields of Form API is used to retrieve the list of field components available in a specified form using its formLinkName. The API requires an Authorization header with a Zoho OAuth token. The formLinkName is a path parameter that specifies the form to retrieve components for. The response includes details about each component, such as its type, options, label name, display type, and whether it is mandatory. The API supports two scopes: ZOHOPEOPLE.forms.ALL for complete access and ZOHOPEOPLE.form.READ for read-only access. The API has a threshold limit of 400 requests per minute, with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Files API

  • ID: get_files_api
  • Operation: read
  • Entities: role, location, file
  • Summary: The Get Files API allows users to retrieve files from Zoho People based on various parameters. The API requires an authorization header with a Zoho OAuth token. Query parameters include fileType (1 for Company Files, 0 for HR Files), start and limit for pagination, and optional parameters such as roleId, catId, employeeId, locationId, and filterBy. The response includes details about the files such as fileOwnerName, fileName, fileCatName, filePath, and more, along with a message and status indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Files Categories API

  • ID: get_files_categories
  • Operation: read
  • Entities: employee, file, category
  • Summary: The Get Files Categories API retrieves the categories of files available in the Zoho People system. It requires an authorization header with a Zoho OAuth token. The response includes details about each file such as the owner's name, file name, category name, file path, role ID, date, description, location ID, decrypted file path, creator's name, confidentiality level, category ID, owner ID, reporting status, usage space, file type, and file ID. The response also includes a message, the URI of the request, and the status of the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get General Settings in Time Tracker

  • ID: get_general_settings_in_time_tracker
  • Operation: read
  • Entities: timesheet, time tracker, general setting
  • Summary: The Get General Settings in Time Tracker API is used to retrieve the general settings configured in the time tracker module of Zoho People. The API requires an OAuth token for authentication, which should be included in the request headers. The response includes various settings such as manual and automatic time logging permissions, billing and client timesheet types, default view settings, and more. The response is returned in JSON format, detailing each setting and its current configuration.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Holidays API

  • ID: get_holidays
  • Operation: read
  • Entities: employee, holiday
  • Summary: The Get Holidays API is used to fetch specific holidays for employees using their employee ID, email ID, or record ID as parameters. The API requires an authorization header with a Zoho OAuth token and a query parameter 'userId' which can be an Employee Id, Employee MailId, or Record Id. The response includes a message, a list of holidays with details such as Name, LocationId, LocationName, Remarks, and Id, a status code, and the URI of the API endpoint. The API has a threshold limit of 30 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Details API

  • ID: get_job_details
  • Operation: read
  • Entities: project, client, job
  • Summary: The Get Job Details API is used to retrieve detailed information about a specific job in the Zoho People Time Tracker. The API requires an OAuth token for authorization and accepts query parameters such as 'jobId' (mandatory), 'dateFormat', and 'includeDept'. The response includes job details such as job name, project details, client information, job status, hours logged, and assignees. If 'includeDept' is set to true, department details are also included. The API supports error handling with specific error codes and messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Schedule API

  • ID: get_job_schedule_api
  • Operation: read
  • Entities: project, employee, job schedule
  • Summary: The Get Job Schedule API is used to retrieve the list of job schedules for employees within a specified date range. The API requires an OAuth token for authorization and supports query parameters such as user, sIndex, limit, fromDate, and toDate. The fromDate and toDate parameters are mandatory and must be in the yyyy-MM-dd format. The API returns a list of job schedules, including details such as employee ID, job name, schedule date, and more. The response also indicates if more data is available with the isNextAvailable flag. Error codes are provided for permission issues, missing parameters, and incorrect date formats.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Jobs API

  • ID: get_jobs_api
  • Operation: read
  • Entities: project, client, job
  • Summary: The Get Jobs API is used to retrieve a list of jobs from the Zoho People Time Tracker. It requires an authorization header with a Zoho OAuth token. The API supports various query parameters such as 'assignedTo', 'assignedBy', 'jobStatus', 'projectId', 'clientId', 'dateFormat', 'isAssigneeCount', 'fetchLoggedHrs', 'sIndex', and 'limit'. The 'assignedTo' parameter is mandatory, while others are optional with default values. The response includes job details such as jobId, jobName, projectId, clientId, fromDate, toDate, description, jobBillableStatus, ratePerHour, jobStatus, hours, totalhours, owner, assignedBy, assigneeCount, and isDeleteAllowed. The API also provides error codes for various error scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Leave Booked and Balance Report API

  • ID: get_leave_booked_and_balance_report
  • Operation: read
  • Entities: report, employee, leave type
  • Summary: The Leave Booked and Balance Report API provides a detailed report of the booked and balance leave counts for employees, categorized by leave type. The API requires an authorization token and accepts several query parameters, including mandatory parameters such as 'from', 'to', and 'unit'. Optional parameters include 'leavetype', 'employee', 'department', 'employeeStatus', 'startIndex', and 'limit'. The response includes details of leave types and a report for each employee, showing booked and balance leave counts, along with employee details. The API has a threshold limit of 30 requests per minute and a lock period of 2 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Leave Records API V2

  • ID: get_leave_records_api_v2
  • Operation: read
  • Entities: employee, leave record, leave type
  • Summary: The Get Leave Records API V2 is used to fetch leave records from Zoho People. It requires an OAuth token for authentication and supports various query parameters such as 'portalID', 'from', 'to', 'dateFormat', 'startIndex', 'limit', 'employee', 'leavetype', 'approvalStatus', and 'dateSelect'. The API returns leave records with details such as leave type, approval status, employee information, and leave duration. The response includes a maximum of 200 records per request, and the API has a threshold limit of 30 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Leave Types API

  • ID: get_leave_types
  • Operation: read
  • Entities: employee, leave type, leave balance
  • Summary: The Get Leave Types API is used to retrieve the leave types available for a specific employee in the Zoho People system. The API requires an OAuth token for authentication and a userId as a query parameter, which can be the Employee Id, Employee MailId, or Record Id. The response includes a list of leave types with details such as the name, permitted count, availed count, ID, unit, and balance count of each leave type. The API has a threshold limit of 30 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

View List of Categories API

  • ID: get_list_of_categories
  • Operation: read
  • Entities: location, service, category
  • Summary: The View List of Categories API is used to retrieve a list of categories that a user can raise queries to. The request requires an Authorization header with a Zoho OAuth token. The response includes details about each category such as whether the user is an agent, the category icon, whether the category is enabled, a short description, service ID, applicable locations, category name, and category ID. The API has a threshold limit of 30 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Requisite Course Entities API

  • ID: get_list_requisite_course_entities
  • Operation: read
  • Entities: learner, batch, course
  • Summary: The List Requisite Course Entities API is used to retrieve a list of course entities that must be completed to unlock the current course entity. It requires the course ID, batch ID, learner ID, and locked entity ID as path parameters. The batch ID should be '0' for self-paced learning. The request must include an Authorization header with a valid Zoho OAuth token. The response includes a list of locked entities with their names, IDs, and types, along with a response code and message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Loss Of Pay Report API

  • ID: get_loss_of_pay_report
  • Operation: read
  • Entities: pay period, employee, loss of pay report
  • Summary: The Loss Of Pay Report API retrieves the Loss of Pay (LOP) report for a specific pay cycle. It requires the payPeriodSettingId, from, and to parameters to specify the pay period and cycle dates. Optional parameters include employee IDs, report unit (Day or Hour), startIndex, limit, and dateFormat. The response includes detailed LOP information for each employee, such as total, booked, carryOver, adjustment, PreviousPayPeriodBalance, and lop, along with employee details like name, id, and email.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Module Assignments API

  • ID: get_module_assignments
  • Operation: read
  • Entities: module, assignment, course
  • Summary: The Fetch Module Assignments API is used to retrieve assignments from a specific module within a course or batch in the Learning Management System (LMS). The API supports two types of courses: Self Paced Learning and Blended Learning. The request requires an OAuth token for authentication and can be scoped for complete access (ALL) or read-only access (READ). The API uses the GET method and accepts path parameters for courseId and moduleId, with an optional batchId for Blended Learning courses. A query parameter, startIndex, can be used to specify the starting record for the response, with a default value of 0. The response includes a list of assignments with details such as assignment marks, description, resources, and permissions for editing or deleting. The response also indicates if there are more records to fetch.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Module Links API

  • ID: get_module_links
  • Operation: read
  • Entities: module, course, link
  • Summary: The Fetch Module Links API is used to retrieve links within modules of courses or batches in the LMS. It supports two types of courses: Self Paced and Blended Learning. The API requires an OAuth token for authorization and can be accessed with either complete or read-only permissions. The request URL varies slightly depending on the course type, with an additional batchId parameter for Blended Learning courses. The API returns a list of links with details such as lock status, link ID, URL, description, and associated resources. The response also indicates if more records are available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Module Offline Tests API

  • ID: get_module_offline_tests
  • Operation: read
  • Entities: module, course, offline test
  • Summary: The Fetch Module Offline Tests API is used to retrieve offline tests within modules of a course or batches in a Learning Management System (LMS). The API supports two types of courses: Self Paced and Blended Learning. The endpoint requires a course ID and module ID, and optionally a batch ID for blended courses. The request must include an Authorization header with a Zoho OAuth token. The API supports a query parameter 'startIndex' to specify the starting record for fetching, with a default value of 0. The response includes details about offline tests such as total learners count, test description, resources, test duration, and more. The response also indicates if there are more records to fetch.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Module Sessions API

  • ID: get_module_sessions
  • Operation: read
  • Entities: module, batch, course
  • Summary: The Fetch Module Sessions API is used to retrieve session details for specific modules within batches in a Learning Management System (LMS). The API requires the courseId, batchId, and moduleId as path parameters to specify the context of the sessions being fetched. An optional query parameter, startIndex, can be used to specify the starting point for fetching records, with a default value of 0. The API requires an Authorization header with a Zoho OAuth token. The response includes details about each session, such as session name, start and end times, description, and trainer information, along with metadata like the total number of learners and whether the session is completed. The response also indicates if there are more records to fetch.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Pay Period Details API

  • ID: get_pay_period_details
  • Operation: read
  • Entities: location, user, pay period
  • Summary: The Fetch Pay Period Details API is used to retrieve details about pay periods for specified users or locations. The API requires an Authorization header with a Zoho OAuth token. It accepts optional query parameters such as userErecNo, locationName, and locationId to filter the pay period details. If no parameters are provided, all pay period data will be fetched. The response includes details such as location list, start and end dates, pay period name and ID, freeze status, and frequency. The API is accessible only to admins and has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Pay Period Settings API

  • ID: get_pay_period_settings
  • Operation: read
  • Entities: location, pay period setting
  • Summary: The Pay Period Settings API retrieves the pay period configuration in Zoho People. It requires an Authorization header with a Zoho OAuth token. The API does not require any path or query parameters. The response includes details about pay period settings such as id, name, period, type, start and end dates, closure dates, and associated locations. The response also includes a message, URI, and status code. The API has a threshold limit of 30 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Payroll Report API

  • ID: get_payroll_report
  • Operation: read
  • Entities: employee, payroll report, pay period
  • Summary: The Payroll Report API provides payroll data for specified users within a given date range. It requires an authorization token and supports various query parameters such as userErecNo, fromDate, toDate, and others to filter the data. The API returns detailed payroll information including regular hours, overtime, paid leave, and total amounts. It also handles errors with specific error codes and messages. The API has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Project Details API

  • ID: get_project_details
  • Operation: read
  • Entities: project, client, department
  • Summary: The Get Project Details API is used to retrieve detailed information about a specific project in the Zoho People Time Tracker. The API requires an OAuth token for authorization and the project ID as a mandatory query parameter. Optional query parameters include 'isUserCount', 'isJobCount', and 'includeDept' to fetch additional details like user count, job count, and department information respectively. The response includes project details such as project name, cost, client information, status, owner details, and optionally, job count, user count, and department details. The API has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Projects API

  • ID: get_projects_api
  • Operation: read
  • Entities: project, employee, client
  • Summary: The Get Projects API is used to retrieve a list of projects from Zoho People. It requires an authorization header with a Zoho OAuth token. The API supports various query parameters such as 'clientId', 'assignedTo', 'projectStatus', 'projectManager', 'searchProjectKey', 'searchProjectName', 'isUserCount', 'isJobCount', 'sIndex', and 'limit' to filter and paginate the results. The response includes project details such as project name, ID, cost, client information, status, owner details, and optionally, job and user counts. The API has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Record Count API

  • ID: get_record_count
  • Operation: read
  • Entities: form, employee, record count
  • Summary: The Record Count API provides the total record counts of an employee form for a specified month and year. The API requires an authentication token, month, and year as query parameters. The response returns the count of records in JSON format, indicating the total number of records for the specified time period.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Regularization Records API

  • ID: get_regularization_records
  • Operation: read
  • Entities:
  • Summary: The Get Regularization Records API is used to fetch multiple records of regularization requests raised within a specified date range. It can retrieve attendance records for a specific employee. The API requires an Authorization header with a Zoho OAuth token. If a recordId is provided, it takes precedence over other parameters. If not, fromdate and todate become mandatory. The dateFormat parameter specifies the format of the dates. The employeeId parameter is optional and used to fetch records for a specific employee. The startIndex parameter is used for pagination, allowing a maximum of 200 records per request. The API response includes details such as recordId, approvalStatus, regDetails, employeeName, and employeeId.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Regularization Records API

  • ID: get_regularized_attendance
  • Operation: read
  • Entities:
  • Summary: The Get Regularization Records API is used to fetch multiple records of regularization requests raised within a specified date range. It can retrieve attendance records for a specific employee. The API requires an Authorization header with a Zoho OAuth token. If a recordId is provided, it takes precedence over other parameters. If not, fromdate and todate become mandatory. The dateFormat parameter specifies the format of the dates. The employeeId parameter is optional and used to fetch records for a specific employee. The startIndex parameter is used for pagination, allowing a maximum of 200 records per request. The API response includes details such as recordId, approvalStatus, regDetails, employeeName, and employeeId.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Related Records API

  • ID: get_related_records
  • Operation: read
  • Entities: employee, record, department
  • Summary: The Get Related Records API retrieves records based on a lookup Record ID from a specified form in Zoho People. The API requires the formLinkName as a path parameter and accepts several query parameters including sIndex, limit, parentModule, id, and lookupfieldName. The Authorization header with a valid Zoho OAuth token is mandatory. The response includes a message, status, and an array of related records with details such as Department Lead, Parent Department, Department name, and Mail Alias. The API supports both JSON and XML response formats.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Search Records Based on Record Values

  • ID: get_search_records_based_on_record_values
  • Operation: read
  • Entities: form, field, record
  • Summary: This API is used to fetch all the records of a form based on the record values. The request requires an authorization header with a Zoho OAuth token. The URL endpoint includes the form link name as a path parameter. The query parameters include 'searchParams' which is a JSON string specifying the search criteria, 'viewName' for the view to fetch records from, 'sIndex' for the starting index, and 'rec_limit' for the number of records to fetch. The response includes a message indicating the status and a result array containing the records that match the search criteria.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Shared Users List API

  • ID: get_shared_users_list
  • Operation: read
  • Entities: user, course
  • Summary: The Get Shared Users List API is used to retrieve the list of users who have access to a specific course in the LMS. The API requires an OAuth token for authorization and accepts a courseId as a path parameter to specify the course. An optional query parameter, startIndex, can be used to specify the starting point for fetching records. The response includes a list of shared users with details such as their record number, display name, employee ID, email ID, and display picture URL. The response also includes a code and message indicating the success of the operation, and a boolean flag indicating if there are more records to fetch.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Getting Shift Details Of Employee API

  • ID: get_shift_details_of_employee
  • Operation: read
  • Entities: employee, configuration, shift
  • Summary: The Getting Shift Details Of Employee API is used to fetch the shift configuration details of an employee for a specified duration. The API requires an OAuth token for authentication and accepts query parameters such as empId, emailId, mapId, sdate, and edate. At least one of empId, emailId, or mapId must be specified, along with the start and end dates in the format yyyy-MM-dd. The response includes details of shifts mapped to the employee, including shift ID, start and end times, weekends, and holidays. The API has a threshold limit of 60 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Single Announcement by ID

  • ID: get_single_announcement_by_id
  • Operation: read
  • Entities: owner, comment, announcement
  • Summary: The Get Single Announcement by ID API allows users to fetch a specific announcement using its unique ID. The request requires an OAuth token for authentication and the announcement ID as a query parameter. The response includes details of the announcement such as owner, subject, message, and status. The API has a threshold limit of 20 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Assignment API

  • ID: get_single_assignment
  • Operation: read
  • Entities: module, assignment, course
  • Summary: The Fetch Single Assignment API is used to retrieve details of a specific assignment within a Learning Management System (LMS). The API requires the course ID, module ID, and assignment ID as path parameters. It also requires an authorization header with a Zoho OAuth token. The response includes details such as the assignment's marks, description, resources, and various permissions related to the assignment. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.READ for read-only access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Single Attendance Record - User Report API

  • ID: get_single_attendance_record_user_report
  • Operation: read
  • Entities: attendance detail, employee, report
  • Summary: The Single Attendance Record - User Report API is used to retrieve attendance details of employees from the attendance reports page. It provides information such as overtime/deviation time, total working hours, and more for a specific employee over a specified period. The API requires a start date (sdate) and end date (edate) as mandatory query parameters. Additionally, at least one of the following parameters must be provided: empId (employee ID), emailId (email ID), or mapId (mapper ID). The dateFormat parameter is optional and specifies the format of the dates. The API returns detailed attendance information for the specified period, including shift start and end times, attendance status, break hours, and total working hours.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Batch API

  • ID: get_single_batch
  • Operation: read
  • Entities: learner, batch, course
  • Summary: The Fetch Single Batch API is used to retrieve details of a specific batch within a course in the Learning Management System (LMS). The API requires the course ID and batch ID as path parameters and an authorization token in the header. It returns details such as the number of learners, start and end dates, batch name, capacity, and publish status. The response includes a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Content API

  • ID: get_single_content_details
  • Operation: read
  • Entities: course, module, content
  • Summary: The Fetch Single Content API is used to retrieve details of a specific content within a module of a course in the Learning Management System (LMS). The API requires the courseId, moduleId, and contentId as path parameters to identify the specific content. An authorization header with a Zoho OAuth token is required for authentication. The API supports two types of scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.READ for read-only access. The response includes details such as whether the content is introductory, mandatory, its description, resources associated with it, and other metadata like content name, duration, and lock status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Course API

  • ID: get_single_course_info
  • Operation: read
  • Entities: user, course, category
  • Summary: The Fetch Single Course API is used to retrieve detailed information about a specific course identified by its courseId. The API requires an authorization header with a Zoho OAuth token. It supports an optional query parameter 'batchId' to specify the batch for blended learning courses. The response includes comprehensive details about the course, such as its URL, type, permissions, categories, progress, and associated files. The API also provides information about the user's role and permissions related to the course, such as the ability to enroll, share, or delete the course.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Module API

  • ID: get_single_module_details
  • Operation: read
  • Entities: module, batch, course
  • Summary: The Fetch Single Module API is used to retrieve details of a specific module within a Learning Management System (LMS). It supports two types of courses: Self-Paced and Blended Learning. The API requires an OAuth token for authorization and can be accessed with either complete or read-only permissions. The request URL varies slightly depending on the course type, with an additional 'batchId' parameter for Blended Learning courses. The response includes detailed information about the module, such as its duration, lock status, name, description, and associated entity data, which may include links and resources.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Offline Test API

  • ID: get_single_offline_test
  • Operation: read
  • Entities: module, course, offline test
  • Summary: The Fetch Single Offline Test API is used to retrieve details of a specific offline test within a Learning Management System (LMS). The API requires an authorization header with a Zoho OAuth token. The endpoint URL varies depending on whether the course is self-paced or blended learning, with the latter requiring an additional batchId path parameter. The response includes details such as the total number of learners, test description, resources, test duration, and other attributes related to the offline test.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Online Test API

  • ID: get_single_online_test
  • Operation: read
  • Entities: module, online test, course
  • Summary: The Fetch Single Online Test API is used to retrieve details of a specific online test within a Learning Management System (LMS). The API requires the course ID, module ID, and online test ID as path parameters. For blended learning courses, a batch ID is also required. The request must include an authorization header with a Zoho OAuth token. The response includes details about the online test, such as the preview URL, test duration, number of learners, and test status. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.READ for read-only access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record API

  • ID: get_single_record
  • Operation: read
  • Entities: form, record, department
  • Summary: The Fetch Single Record API retrieves the record of a specific form indexed using a Record ID. The API requires an OAuth token for authorization and accepts the formLinkName and recordId as query parameters. The response includes details such as the department lead, email, parent department, and other related information. The API supports two scopes: ZOHOPEOPLE.forms.ALL for complete access and ZOHOPEOPLE.forms.READ for read-only access. The API has a threshold limit of 400 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of AddressProof (Section Wise)

  • ID: get_single_record_of_addressproof
  • Operation: read
  • Entities: employee ID related field, address proof detail, approval status
  • Summary: This API fetches a single record of the AddressProof form section-wise using a specified Record ID. It requires an OAuth token for authentication and a record ID as a query parameter. The response includes detailed information about the address proof request, such as the date of request, employee details, reason for request, and approval status. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of BonafideLetter (Section Wise)

  • ID: get_single_record_of_bonafideletter
  • Operation: read
  • Entities: Employee, Department, Bonafide Letter
  • Summary: This API fetches a single record of the BonafideLetter form by using a specific Record ID. It requires an OAuth token for authentication and a CSRF token in the headers. The 'recordId' query parameter is mandatory to specify which record to fetch. The response includes details such as the date of request, employee-related fields, reason for request, and approval status. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of Department

  • ID: get_single_record_of_department
  • Operation: read
  • Entities: form, record, department
  • Summary: This API fetches a single record of a department from Zoho People using the specified record ID. It requires an OAuth token for authentication and session cookies for maintaining the session. The API returns details such as department name, lead, modification details, and more. The response includes a message indicating the success of the operation and the status code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of Department (Section Wise)

  • ID: get_single_record_of_department_section_wise
  • Operation: read
  • Entities: parent department, department detail, department
  • Summary: This API fetches a single record of a department in a section-wise manner using the department's Record ID. It requires an OAuth token for authentication and session cookies for maintaining the session. The request must include the 'recordId' as a query parameter to specify which department record to fetch. The response includes detailed information about the department, such as the department lead, modification details, and approval status. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of Designation

  • ID: get_single_record_of_designation
  • Operation: read
  • Entities: form, designation, record
  • Summary: This API fetches a single record of a designation from Zoho People using the specified record ID. The request requires an OAuth token for authorization and CSRF/session cookies. The record ID is passed as a query parameter. The response includes details such as the designation name, modification and addition details, mail alias, and approval status. The API has a threshold limit of 400 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of Designation (Section Wise)

  • ID: get_single_record_of_designation_section_wise
  • Operation: read
  • Entities: form, designation, record
  • Summary: This API fetches a single record of a designation from Zoho People by using a specific record ID. The request requires an OAuth token for authentication and session cookies for maintaining the session. The 'recordId' query parameter is mandatory and specifies the ID of the designation record to be fetched. The response includes details of the designation such as the name, modification details, and approval status. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of Employee

  • ID: get_single_record_of_employee
  • Operation: read
  • Entities: designation, employee, department
  • Summary: This API fetches a single employee record from Zoho People using the specified record ID. It requires an OAuth token for authentication and a CSRF token in the headers. The record ID is passed as a query parameter. The response includes detailed information about the employee, such as personal details, job details, and contact information. The API supports two scopes: ZOHOPEOPLE.forms.ALL for full access and ZOHOPEOPLE.forms.READ for read-only access. The API has a threshold limit of 400 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of Employee (Section Wise)

  • ID: get_single_record_of_employee_section_wise
  • Operation: read
  • Entities: form, employee, record
  • Summary: This API fetches a single employee record from Zoho People by section-wise using a specified Record ID. The request requires an OAuth token for authentication and session cookies. The 'recordId' query parameter is mandatory to specify the employee record to be fetched. The response includes detailed information about the employee, such as identity information, basic information, contact details, education details, work experience, personal details, work information, and more. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of Exit Interview

  • ID: get_single_record_of_exit_interview
  • Operation: read
  • Entities: exit interview, record, form
  • Summary: This API fetches a single record from the exit interview form using a specified Record ID. It requires an OAuth token for authentication and session cookies for maintaining the session. The API endpoint accepts a query parameter 'recordId' which is mandatory and identifies the specific record to be fetched. The response includes detailed information about the exit interview record such as the employee's details, interviewer's details, and other related information. The API has a threshold limit of 400 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of exitinterview (Section Wise)

  • ID: get_single_record_of_exitinterview
  • Operation: read
  • Entities: exit interview, record, section
  • Summary: This API fetches a single record of the 'exitinterview' form section-wise using a specific Record ID. It requires an OAuth token for authentication and session cookies for maintaining the session. The request must include the 'recordId' as a query parameter to specify which record to fetch. The response includes detailed information about the separation, checklist for exit interview, questionnaire, and approval status of the record. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes between consecutive requests.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of ExperienceLetter (Section Wise)

  • ID: get_single_record_of_experienceletter
  • Operation: read
  • Entities: employee, experience letter, department
  • Summary: This API fetches a single record of an ExperienceLetter form section-wise using a specified Record ID. It requires an OAuth token for authentication and session cookies. The request must include the 'recordId' as a query parameter to specify which record to fetch. The response includes details such as the date of request, employee details, reason for request, and approval status. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of Leave

  • ID: get_single_record_of_leave
  • Operation: read
  • Entities: employee, leave, approval status
  • Summary: This API fetches a single record of leave from Zoho People using a specific Record ID. It requires an OAuth token for authentication and a record ID as a query parameter. The response includes details such as Employee ID, leave type, dates, and approval status. The API supports two scopes: ZOHOPEOPLE.forms.ALL for full access and ZOHOPEOPLE.forms.READ for read-only access. The API has a threshold limit of 400 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of Leave (Section Wise)

  • ID: get_single_record_of_leave_section_wise
  • Operation: read
  • Entities: employee, record, leave
  • Summary: This API fetches a single record of leave from Zoho People by section-wise using a specific Record ID. It requires an OAuth token for authentication and a record ID as a query parameter. The response includes details about the leave such as leave type, employee ID, day details, and approval status. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of P_ClientDetails (Section Wise)

  • ID: get_single_record_of_p_clientdetails
  • Operation: read
  • Entities: client detail, client, contact
  • Summary: This API fetches a single record of the P_ClientDetails form section-wise using a specified record ID. It requires an OAuth token for authentication and CSRF/session cookies. The request must include the recordId as a query parameter. The response includes details about the client, contacts, and approval status, along with a message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of P_Task

  • ID: get_single_record_of_p_task
  • Operation: read
  • Entities: form, task, record
  • Summary: This API fetches a single record from the P_Task form using a specified Record ID. The request requires an OAuth token for authorization and session cookies for maintaining the session. The 'recordId' query parameter is mandatory and specifies the ID of the record to be fetched. The response includes details of the task such as status, description, due date, priority, task owner, and more. The API supports two scopes: ZOHOPEOPLE.forms.ALL for full access and ZOHOPEOPLE.forms.READ for read-only access. The API has a threshold limit of 400 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of P_Task (Section Wise)

  • ID: get_single_record_of_p_task_section_wise
  • Operation: read
  • Entities: form, task, record
  • Summary: This API fetches a single record of the P_Task form section-wise using a specified Record ID. It requires an OAuth token for authentication and session cookies for maintaining the session. The request must include the 'recordId' as a query parameter to specify which record to fetch. The response includes detailed task information such as status, description, due date, priority, task owner, and more. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes between consecutive requests.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of P_TimesheetJob

  • ID: get_single_record_of_p_timesheetjob
  • Operation: read
  • Entities: form, record, timesheet job
  • Summary: This API fetches a single record from the P_TimesheetJob form using a specified Record ID. The request requires an OAuth token for authorization and session cookies for maintaining the session. The recordId query parameter is mandatory and specifies the ID of the record to be fetched. The response includes details about the job such as JobOwner, RatePerHour, Description, and other job-related information. The API has a threshold limit of 400 requests per minute, with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of P_TimesheetJobsList (Section Wise)

  • ID: get_single_record_of_p_timesheetjobslist
  • Operation: read
  • Entities: approval status, P_TimesheetJobsList, project configuration detail
  • Summary: This API fetches a single record from the P_TimesheetJobsList form in Zoho People, identified by a specific record ID. The request requires an OAuth token for authentication and CSRF/session cookies. The record ID must be provided as a query parameter. The response includes detailed project configuration information, such as project head, project name, and approval status, organized section-wise. The API supports two scopes: ZOHOPEOPLE.forms.ALL for full access and ZOHOPEOPLE.forms.READ for read-only access. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of Travel Expenses (Section Wise)

  • ID: get_single_record_of_travel_expenses
  • Operation: read
  • Entities: employee, record, travel expense
  • Summary: This API fetches a single record of travel expenses section-wise using a specified Record ID. It requires an OAuth token for authentication and the record ID as a query parameter. The response includes detailed information about the expense, such as modification details, travel ID, employee ID, and approval status. The API supports two scopes: ZOHOPEOPLE.forms.ALL for full access and ZOHOPEOPLE.forms.READ for read-only access. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of travelrequest (Section Wise)

  • ID: get_single_record_of_travelrequest
  • Operation: read
  • Entities: employee, travel request, department
  • Summary: This API fetches a single record of a travel request form section-wise using a specified Record ID. It requires an OAuth token for authentication and a CSRF token in the cookies. The main query parameter is 'recordId', which identifies the specific record to be fetched. The response includes detailed information about the travel request, such as travel ID, employee details, and approval status. The API supports two scopes: ZOHOPEOPLE.forms.ALL for full access and ZOHOPEOPLE.forms.READ for read-only access. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record of P_TimesheetJob (Section Wise)

  • ID: get_single_record_p_timesheetjob
  • Operation: read
  • Entities: form, record, job
  • Summary: This API fetches a single record of the P_TimesheetJob form section-wise using a specified record ID. The request requires an OAuth token for authorization and a CSRF token in the cookies. The record ID is passed as a query parameter. The response includes detailed job configuration details such as JobOwner, RatePerHour, Job_Name, and more, along with the approval status. The API has a threshold limit of 400 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Record API (Section Wise)

  • ID: get_single_record_section_wise
  • Operation: read
  • Entities: form, record, section
  • Summary: The Fetch Single Record API (Section Wise) retrieves all the records of a specific form indexed by a Record ID, organized section-wise. The API requires the formLinkName and recordId as query parameters, and an Authorization header with a Zoho OAuth token. The response includes details of department members and department details, such as email, department lead, and mail alias. The API supports two scopes: ZOHOPEOPLE.forms.ALL for complete access and ZOHOPEOPLE.forms.READ for read-only access. The API has a threshold limit of 400 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Room API

  • ID: get_single_room
  • Operation: read
  • Entities: facility, location, room
  • Summary: The Fetch Single Room API is used to retrieve details of a specific room in the LMS. The API requires an OAuth token for authorization and the room ID as a path parameter. Optionally, a startIndex query parameter can be provided to specify from which record the response should begin. The response includes the room's name, location, facilities, room ID, and capacity. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.READ for read-only access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Session API

  • ID: get_single_session_details
  • Operation: read
  • Entities: module, course, session
  • Summary: The Fetch Single Session API is used to retrieve details of a specific session in a Learning Management System (LMS). The API requires the course ID, batch ID, module ID, and session ID as path parameters. The request must include an Authorization header with a valid Zoho OAuth token. The response includes details about the session such as the session name, start and end times, description, resources, room ID, trainer, and other session-specific information. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.READ for read-only access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Single Trainer API

  • ID: get_single_trainer_details
  • Operation: read
  • Entities: trainer, course, skill
  • Summary: The Fetch Single Trainer API is used to retrieve details of a specific trainer in the Learning Management System (LMS) by providing the trainer's unique identifier in the URL path. The API requires an authorization header with a Zoho OAuth token. The response includes detailed information about the trainer, such as their skills, courses, display name, rating, and more. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.READ for read-only access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Suggested Courses Count API

  • ID: get_suggested_courses_count
  • Operation: read
  • Entities: suggestion, statistic, course
  • Summary: The Get Suggested Courses Count API is used to retrieve the count of suggested courses in the Learning Management System (LMS). The API requires an Authorization header with a Zoho OAuth token for authentication. The token must have either the ZOHOPEOPLE.training.ALL or ZOHOPEOPLE.training.READ scope, which allows complete access or read-only access to the data, respectively. The API responds with a JSON object containing a response code, the count of suggested courses, and a message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Time Logs API

  • ID: get_time_logs
  • Operation: read
  • Entities: employee, time log, job
  • Summary: The Get Time Logs API is used to fetch specific time logs from Zoho People. It requires an authorization header with a Zoho OAuth token. The API supports various query parameters such as user, jobId, fromDate, toDate, dateFormat, clientId, projectId, billingStatus, approvalStatus, isCommentsCount, sIndex, and limit to filter the time logs. The response includes detailed information about each time log, including employee details, work date, time log type, billing status, approval status, and more. The API also handles errors with specific error codes and messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Time Logs Details API

  • ID: get_time_logs_details
  • Operation: read
  • Entities: employee, time log, job
  • Summary: The Get Time Logs Details API is used to retrieve the details of a specific time log from Zoho People. The API requires an OAuth token for authentication and a mandatory query parameter 'timelogId' to specify the time log to be fetched. Optional query parameters include 'isTimerDetails' to fetch timer intervals for timer type logs and 'isCommentsCount' to fetch the number of comments. The response includes detailed information about the time log, such as employee details, work date, time intervals, job and project information, billing status, and more. The API supports error handling with specific error codes and messages. The API has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Timesheet Records for an Employee

  • ID: get_timesheet_records_for_employee
  • Operation: read
  • Entities:
  • Summary: The Retrieve Timesheet Records for an Employee API is used to fetch timesheet records for a specified user. It requires an authorization header with a Zoho OAuth token. The API accepts query parameters such as 'user', which is mandatory, and optional parameters like 'approvalStatus', 'employeeStatus', 'dateFormat', 'fromDate', 'toDate', 'sIndex', and 'limit'. The response includes detailed timesheet information such as 'recordId', 'timesheetName', 'employeeName', 'status', and hours worked, along with a message and status code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Timesheet Records for an Employee

  • ID: get_timesheets
  • Operation: read
  • Entities:
  • Summary: The Retrieve Timesheet Records for an Employee API is used to fetch timesheet records for a specified user. It requires an authorization header with a Zoho OAuth token. The API accepts query parameters such as 'user', which is mandatory, and optional parameters like 'approvalStatus', 'employeeStatus', 'dateFormat', 'fromDate', 'toDate', 'sIndex', and 'limit'. The response includes detailed timesheet information such as 'recordId', 'timesheetName', 'employeeName', 'status', and hours worked, along with a message and status code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Timesheets Details API

  • ID: get_timesheets_details
  • Operation: read
  • Entities: timesheet, employee, client
  • Summary: The Get Timesheets Details API is used to retrieve details from a specific timesheet in Zoho People. The API requires an OAuth token for authorization and accepts a mandatory 'timesheetId' query parameter to specify the timesheet to be retrieved. An optional 'dateFormat' query parameter can be provided to specify the format of the dates in the response, with a default format of 'yyyy-MM-dd'. The API returns a detailed response including approval details, timesheet entries, additional timesheet details, and leave data. The response includes information such as approval status, work dates, billed status, project details, and more. The API supports two scopes: 'ZOHOPEOPLE.timetracker.ALL' for complete access and 'ZOHOPEOPLE.timetracker.READ' for read-only access. Error codes and messages are provided for handling various error scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Trainers List API

  • ID: get_trainers_list
  • Operation: read
  • Entities: employee, training, trainer
  • Summary: The Fetch Trainers List API is used to retrieve details of trainers in the Learning Management System (LMS). It requires an authorization header with a Zoho OAuth token. The API supports query parameters such as 'startIndex' to specify the starting record, 'employeeStatus' to filter trainers by their status (active or inactive), and 'sortBy' to determine the order of the results (ascending or descending). The response includes a list of trainers with details such as their unique record number, display name, employee ID, display picture URL, and trainer ID. The response also contains a code and message indicating the success of the operation, and a boolean flag 'hasMoreRecords' to indicate if there are more records available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

User Report API

  • ID: get_user_report
  • Operation: read
  • Entities: user, report, leave tracker
  • Summary: The User Report API retrieves the leave report for a specified employee for the current leave year. It requires an authorization header with a Zoho OAuth token and a mandatory query parameter 'employee' which is the Erecno of the employee. An optional 'to' parameter can specify the report end date for the current year. The response includes the employee's name, ID, and details of various leave types including units, names, taken and available counts, types, color codes, and IDs. Some leave types may include additional information about deductible holidays.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

View Case Details API

  • ID: get_view_case_details
  • Operation: read
  • Entities: case, agent, requestor
  • Summary: The View Case Details API allows users to retrieve detailed information about a specific case using its record ID. The API requires an OAuth token for authentication and the record ID as a query parameter. The response includes details about the case such as the agent, requestor, status, category, and any attached files. It also provides information on whether the user can change the case category or status, and SLA details if applicable. The API has a threshold limit of 30 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

View Case Listing API

  • ID: get_view_case_listing
  • Operation: read
  • Entities: case, employee, category
  • Summary: The View Case Listing API allows users to list various cases based on different criteria. Users can request cases that are assigned to them, unassigned cases, open cases, or all cases. The API requires an authorization header with a Zoho OAuth token. Query parameters include 'index' (mandatory), 'status', 'categoryId', 'query', 'requestorErecno', and 'periodOfTime'. The response includes a list of cases with details such as agent information, subject, SLA status, category, requestor details, and more. The API has a threshold limit of 30 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

View Files API

  • ID: get_view_files
  • Operation: read
  • Entities: file
  • Summary: The View Files API allows users to view a specific file by providing the file ID. The request requires an authorization header with a valid Zoho OAuth token and a query parameter 'fileId' to specify the file to be viewed. The response includes the file content, file name, and file type. The file content is returned in a suitable format, such as a base64 encoded string.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch View of a Specific Form API

  • ID: get_view_of_specific_form
  • Operation: read
  • Entities: form, view, department
  • Summary: The Fetch View of a Specific Form API allows users to retrieve a list of views available for a specific form in Zoho People by specifying the formLinkName. The API requires an Authorization header with a Zoho OAuth token and the formLinkName as a path parameter. The response includes an array of views, each with a viewName, displayName, and viewId. The API supports two scopes: ZOHOPEOPLE.forms.ALL for full access and ZOHOPEOPLE.forms.READ for read-only access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Insert Record API

  • ID: insert_record_api
  • Operation: write
  • Entities: form, field, record
  • Summary: The Insert Record API allows users to add a record to a specified form in Zoho People. The API requires an OAuth token for authorization and accepts input data in either XML or JSON format. The inputType and formLinkName are specified as path parameters, while the inputData is provided as a query parameter. The API supports operations with different scopes, such as full access or create-only access. The response includes the primary key ID of the added record, a success message, and the status of the operation. The API has a threshold limit of 300 requests per minute, with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Insert Record API for Adding Employees

  • ID: insert_record_for_adding_employees
  • Operation: write
  • Entities: employee, invitation, organization
  • Summary: The Insert Record API for Adding Employees allows organizations to add employees to Zoho People. Employees can be added by inviting them or directly if the domain is verified. The API requires an OAuth token for authorization and accepts input data in JSON format with mandatory fields such as EmployeeID, FirstName, LastName, and EmailID. Optional parameters include isNonUser and isDirectAdd, which determine the employee's profile type and status. If isDirectAdd is true, a password is required. The API returns a response with the primary key ID of the added employee and a success message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bulk Records API

  • ID: list_all_employees
  • Operation: read
  • Entities:
  • Summary: This API is used to fetch the list of all the employees in the app. The API allows fetching up to 200 records per call. It requires an OAuth token for authorization and supports various query parameters such as 'sIndex' for the starting index, 'limit' for the number of records, 'searchColumn' and 'searchValue' for searching specific records, and 'modifiedtime' for fetching records modified after a certain timestamp. The response includes detailed information about each record, including personal and employment details, and tabular sections like education and work experience.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Modify Client API

  • ID: modify_client_api
  • Operation: write
  • Entities: currency code, client, billing method
  • Summary: The Modify Client API is used to modify the details of a client in the Zoho People Time Tracker. It requires an OAuth token for authorization and accepts various query parameters such as clientId (mandatory), clientName, currency, billingMethod, emailId, firstName, lastName, phoneNo, mobileNo, faxNo, streetAddr, city, state, pincode, country, industry, compsize, and description. The API returns a response indicating the success or failure of the operation, including the modified clientId and a message. The API is restricted to admin users and has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Modifying Jobs API

  • ID: modify_jobs
  • Operation: write
  • Entities: department, job
  • Summary: The Modifying Jobs API allows users to update job records in Zoho People. The API requires an OAuth token for authorization and supports both XML and JSON input formats. Users must specify the formLinkName, inputType, recordId, and inputData as query parameters. The inputData contains the job details to be updated. The API returns a response indicating the success of the operation, including the primary key ID of the updated record and a status message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Leave Balance API

  • ID: modify_leave_balance
  • Operation: write
  • Entities: employee, leave type, balance
  • Summary: The Add Leave Balance API is used to modify an employee's leave balance by adding or subtracting a specified count. The API requires an authorization header with a Zoho OAuth token and accepts query parameters including 'balanceData', a JSON string detailing the employee's leave balance data, and 'dateFormat', which specifies the date format. The response includes the number of leave balances successfully added, any errors encountered, and a status message. The API has a threshold limit of 30 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Modify Project API

  • ID: modify_project_api
  • Operation: write
  • Entities: project, record, timesheet job
  • Summary: The Modify Project API allows users to update project details in Zoho People. The API requires an OAuth token for authorization and accepts input in either XML or JSON format. The request URL includes path parameters for the form link name and input type, and query parameters for the record ID and input data. The API returns a response indicating the success of the operation, including the primary key ID of the updated record and a success message. The API has a threshold limit of 300 requests per minute, with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Modify Timesheet API

  • ID: modify_timesheet_api
  • Operation: write
  • Entities: timesheet, attachment, timetracker
  • Summary: The Modify Timesheet API is used to modify existing timesheets in the Zoho People application. It requires an OAuth token for authorization and allows modification of timesheet details such as the name, description, and approval status. The API supports attaching files to the timesheet by setting the content type to 'multipart/form-data'. The request parameters include 'timesheetId' (mandatory), 'timesheetName', 'description', 'sendforApproval', and 'removeAttachment'. The response includes the modified timesheet ID, a message, and the status of the operation. Error codes are provided for various failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Cancel Leave API

  • ID: patch_cancel_leave
  • Operation: write
  • Entities: record, leave, leave tracker
  • Summary: The Cancel Leave API allows users to cancel a leave record by providing the record ID. The API endpoint requires a PATCH request to the specified URL with the record ID as a path parameter. An optional query parameter 'reason' can be included to specify the reason for cancellation. The request must include an Authorization header with a valid Zoho OAuth token. The API responds with a message and status indicating the success of the cancellation. The API has a threshold limit of 30 requests per minute, with a lock period of 2 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Edit Post Learning Activity - Online Test

  • ID: patch_edit_post_learning_activity_online_test
  • Operation: write
  • Entities: learner, online test, course
  • Summary: This API is used to edit an online test that is part of the course learning activities in the LMS. It requires the course ID and test ID as path parameters, and the online test data as a query parameter in JSON format. The online test data includes mandatory fields such as name, durationFor, maximumAttemptsAllowed, and questionsPerPage, along with optional fields like duration, passPercentage, shuffleQuestions, and more. The API returns a response with the updated online test details, including a preview URL, test status, and other relevant information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Edit Pre Learning Activity - Online Test

  • ID: patch_edit_pre_learning_activity_online_test
  • Operation: write
  • Entities: online test, course, setting
  • Summary: This API is used to update an online test in a pre-learning activity. It requires the course ID and test ID as path parameters, and the online test data as a query parameter in JSON format. The online test data includes mandatory fields such as name, durationFor, maximumAttemptsAllowed, and questionsPerPage, along with optional fields like duration, passPercentage, shuffleQuestions, and more. The API returns a response with the updated online test details, including the preview URL, test status, and other relevant information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Assignment API

  • ID: patch_update_assignment
  • Operation: write
  • Entities: module, assignment, course
  • Summary: The Update Assignment API allows users to update assignments within a module of a course or batch in the LMS. The API requires a PATCH request to the specified URL with the courseId and moduleId as path parameters. The request must include an Authorization header with a Zoho OAuth token. The assignmentData query parameter is mandatory and should be a JSON object containing details such as name, maximumMarks, submissionType, and other optional fields like lateSubmission, description, isMandatory, lockUntil, gradeCategoryId, and resources. The response includes a code, a message, and details of the updated assignment, such as assignMark, totalLearnersCount, description, resources, assignmentId, and other relevant information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Batch API

  • ID: patch_update_batch_details
  • Operation: write
  • Entities: location, batch, course
  • Summary: The Update Batch API is used to update the details of a batch in the Learning Management System (LMS). The API requires the course ID and batch ID as path parameters and a JSON object containing batch details as a query parameter. The batch details include the name, start date, end date, minimum and maximum capacity, locations, and options for waitlisting and cancellation. The API uses a PATCH method and requires an authorization header with a Zoho OAuth token. The response includes the updated batch details and a success message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Batch Scheduler API

  • ID: patch_update_batch_scheduler
  • Operation: write
  • Entities: batch scheduler, location, course
  • Summary: The Update Batch Scheduler API is used to update the batch scheduler in the Learning Management System (LMS). It requires the course ID and batch scheduler ID as path parameters. The request must include an authorization header with a Zoho OAuth token. The batchSchedulerData query parameter is a JSON object containing details about the batch scheduler, such as batch name, start and end dates, frequency, capacity, and other scheduling options. The API returns a response with the updated batch scheduler details, including the batch name, frequency unit, clone type, and other relevant information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Course API

  • ID: patch_update_course
  • Operation: write
  • Entities: permission setting, course, category
  • Summary: The Update Course API allows users to update course details in the LMS. It requires a PATCH request to the specified URL with a JSON object containing course data as a query parameter. The request must include an Authorization header with a Zoho OAuth token. The courseData parameter includes fields such as name, type, description, aboutCourse, duration, durationUnit, courseCode, courseAdmins, categories, and permissionSettings. The response returns a JSON object with the updated course details, including course code, description, URL, type, permission settings, and more, along with a success message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Files in LMS Modules

  • ID: patch_update_files_in_lms_modules
  • Operation: write
  • Entities: file, course, module
  • Summary: The Update Files API allows updating files in modules of courses or batches in the LMS. It requires the course ID, module ID, and file ID as path parameters. The file details are provided as a JSON object in the query parameters, including mandatory fields like 'name' and 'file'. Optional fields include 'duration', 'description', 'isMandatory', 'isIntroFile', 'enableDownload', 'lockUntil', and 'resources'. The API uses a PATCH method and requires an authorization header with a Zoho OAuth token. The response includes details of the updated file and a success message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Link API

  • ID: patch_update_link
  • Operation: write
  • Entities: module, course, link
  • Summary: The Update Link API is used to update a link in the modules of courses or batches in the LMS. It requires the course ID, module ID, and link ID as path parameters. The API uses a PATCH method and requires an authorization header with a Zoho OAuth token. The linkData query parameter is a JSON object that includes mandatory fields such as name and embedURL, and optional fields like description, isMandatory, and lockUntil. The response includes a code, a link object with details of the updated link, and a success message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Modules API

  • ID: patch_update_modules
  • Operation: write
  • Entities: module, batch, course
  • Summary: The Update Modules API is used to update modules in courses or batches in the LMS. It requires the courseId and moduleId as path parameters and moduleData as a query parameter. The moduleData includes mandatory fields such as name, and optional fields like duration, description, lockType, and lockUntil. The API uses a PATCH method and requires an Authorization header with a Zoho OAuth token. The response includes the updated module details and a success message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Offline Test API

  • ID: patch_update_offline_test
  • Operation: write
  • Entities: module, course, offline test
  • Summary: The Update Offline Test API is used to update an offline test in the modules of a course or batch in the LMS. It requires the course ID, module ID, and offline test ID as path parameters. The request must include an authorization header with a Zoho OAuth token. The offline test data is provided as a JSON object in the query parameters, which includes details such as the test name, marks, duration, description, whether it is mandatory, lockUntil date, grade category ID, and resources. The API returns a response with a code and message, along with the updated details of the offline test, including the total learners count, description, resources, duration, and other relevant information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Online Test API

  • ID: patch_update_online_test
  • Operation: write
  • Entities: module, online test, course
  • Summary: The Update Online Test API allows users to update details of an online test within a course module or batch in the LMS. The API requires a PATCH request to the specified URL with the courseId, moduleId, and onlineTestId as path parameters. The request must include an Authorization header with a valid Zoho OAuth token. The onlineTestData query parameter is mandatory and should contain a JSON object with details such as the test name, duration, maximum attempts allowed, and other test settings. The response includes a success message and details of the updated online test, including its preview URL, status, and other attributes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Session API

  • ID: patch_update_session
  • Operation: write
  • Entities: module, batch, session
  • Summary: The Update Session API allows users to update session details in a specific module of a batch in the LMS. The API requires the courseId, batchId, moduleId, and sessionId as path parameters. The sessionData query parameter is a JSON object containing mandatory fields such as name, trainerErecno, type, date, startTime, and endTime, along with optional fields like description, roomId, lockUntil, and gradeCategoryId. The API uses a PATCH method and requires an Authorization header with a Zoho OAuth token. The response includes details of the updated session, such as sessionName, sessionStartTime, sessionEndTime, and other session-related information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add and Edit Folder API

  • ID: post_add_and_edit_folder
  • Operation: write
  • Entities: folder, file module, category
  • Summary: The Add and Edit Folder API allows users to add new folders or edit existing folders in the file modules of Zoho People. The API requires an OAuth token for authorization. Users can specify the new folder name using the 'newCatName' parameter. If the folder is to be placed under an existing folder, the 'parentCatId' parameter should be used. To rename an existing folder, the 'catId' parameter should be provided. The response includes the folder ID, parent folder ID, folder name, a message, the URI of the API endpoint, and a status code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add and Upload File

  • ID: post_add_and_upload_file
  • Operation: write
  • Entities: role, employee, file
  • Summary: The Add and Upload File API allows users to upload files to the Zoho People platform. It supports uploading both Company and HR files with various options for confidentiality, role, category, and employee association. The API requires an OAuth token for authorization and accepts multiple query parameters to specify file details and upload settings. Upon successful upload, it returns a response containing the file ID and a success message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add and Upload File to Employee Profile

  • ID: post_add_and_upload_file_to_employee_profile
  • Operation: write
  • Entities:
  • Summary: This API allows for adding and uploading a file to an employee's profile in one request. It requires an OAuth token for authentication and takes various parameters such as file name, description, type, confidentiality, and employee ID. The response includes the file ID, a message, the URI of the API endpoint, and the status of the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Announcement

  • ID: post_add_announcement
  • Operation: write
  • Entities: announcement, email, location
  • Summary: The Add Announcement API allows users to post an announcement. It requires an authorization header with a Zoho OAuth token. The request parameters include 'subject' and 'message' which are mandatory, while 'expiryDate', 'location', 'emailList', 'notify', 'isSticky', and 'isCommentDisable' are optional. The API returns a response with details of the announcement including owner, message text, email list, subject, notification status, comment disable status, publish date, announcement ID, active status, notified email IDs, and sticky status. The response also includes a message, URI, and status code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Candidate API

  • ID: post_add_candidate
  • Operation: write
  • Entities: employee, candidate, record
  • Summary: The Add Candidate API allows adding a new candidate to the organization. It requires an OAuth token for authentication and expects input data in JSON format with mandatory fields 'First_Name', 'Last_Name', and 'Email_ID'. The API has a threshold limit of 30 requests per minute and a lock period of 5 minutes. Upon successful addition, it returns a response with the primary key ID of the candidate and a success message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Department API

  • ID: post_add_department
  • Operation: write
  • Entities: field, record, department
  • Summary: The Add Department API allows users to add departments one by one in Zoho People. The API requires an OAuth token for authentication and accepts department details in XML format as a query parameter. The response indicates whether the department was successfully added. The API has a threshold limit of 20 requests per minute and a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Jobs API

  • ID: post_add_jobs
  • Operation: write
  • Entities: timesheet, project, job
  • Summary: The Add Jobs API allows users to add job records to a specified form in Zoho People. The API requires an OAuth token for authorization and supports both XML and JSON input formats. Users must specify the form link name and input type in the path parameters, and provide the job data in the query parameters. The response includes a status code, a success message, and the primary key ID of the newly added record.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Leave API

  • ID: post_add_leave
  • Operation: write
  • Entities: employee, record, leave
  • Summary: The Add Leave API allows users to add leave records to the Zoho People system. The API requires an OAuth token for authorization and accepts input parameters such as 'inputType' and 'formLinkName' in the path, and 'inputData' as a query parameter. The 'inputData' should be a JSON string containing details like 'Employee_ID', 'Leavetype', 'From', 'To', and 'days' with specific leave details. The API supports both day-based and hour-based leave entries. The response includes a status message and the primary key ID of the newly added leave record. The API has a threshold limit of 300 requests per minute with a lock period of 5 minutes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated 7 days ago