Skip to main content
Zoho People logo
  • Category: human resources
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 160
  • Triggers: 0
  • Slug: ZOHO_PEOPLE
  • Version: 00000000_00

Tools

Slug: ZOHO_PEOPLE_ADD_LEAVE_BALANCEAdd legacy leave balance for the documented employees and leave types.

Input Parameters

string
Format used by each balance date; organization format is used when omitted.
object
required
Employee IDs mapped to leave type IDs and dated balance changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_ADD_LMS_TRAINERSAdd the supplied employees as Zoho People LMS trainers.

Input Parameters

array
required
Employee record numbers to add as LMS trainers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_ADD_TIMER_COMMENTAdd a comment to a legacy time log or timer.

Input Parameters

string
required
Specify the comment
string
required
Specify the timeLogId

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_APPLY_HOURLY_PERMISSIONSubmit an hourly-permission request.

Input Parameters

string
required
Permission date in organization format.
string
Reason for the permission request.
integer
required
Permission end time in minutes from midnight.
integer
required
Permission start time in minutes from midnight.
string
required
Configured permission type ID.
string
required
Employee record number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_APPROVE_ON_DUTY_REQUESTApprove or reject an on-duty request using the documented decision fields.

Input Parameters

string
required
On-duty record ID.
integer ("0" | "1")
required
Decision: 0 rejected or 1 approved.
object
On-duty detail IDs mapped to rejection or approval decisions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_APPROVE_TIMESHEETApprove or reject one legacy timesheet using the documented decision fields.

Input Parameters

string
Specify the approval comments.
object
Map time-log IDs to typed approval decisions. Omit it to apply approval_status to every time log in the timesheet.
string
required
Specify the timesheet Id
string ("approved" | "rejected")
required
Specify the approval status
boolean
false | To approve the timesheet on behalf of all the approvers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_BULK_CANCEL_LEAVE_REQUESTSCancel the explicitly supplied set of V3 leave request IDs.

Input Parameters

array
required
Leave IDs and cancellation reasons; at most 200 records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CANCEL_COMPENSATORY_REQUESTCancel a V3 compensatory-off request by record ID.

Input Parameters

string
required
Compensatory request record ID to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CANCEL_HOURLY_PERMISSIONCancel an hourly-permission request by record and form ID.

Input Parameters

string
required
Permission form ID.
string
required
Permission record ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CANCEL_LEAVE_GRANTCancel a V3 leave grant request by record ID.

Input Parameters

string
required
Leave grant record ID to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CANCEL_LEAVE_REQUESTCancel one V3 leave request by record ID.

Input Parameters

string
Reason for cancellation.
string
required
Leave request record ID to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CANCEL_ON_DUTY_REQUESTCancel an on-duty request using the documented record fields.

Input Parameters

string
required
On-duty form ID.
string
required
On-duty record ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_AND_TAG_EMPLOYEE_KRASCreate a KRA and tag it to selected employees in one Zoho operation.

Input Parameters

string
required
KRA name.
array
required
Employee record identifiers to receive the KRA.
number
KRA weightage.
string
KRA description.
boolean
Whether to add the KRA to the organization library.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_ATTENDANCE_ENTRIESCreate attendance entries using the V3 provider-native batch contract.

Input Parameters

array
required
Attendance entries to create.
string
required
Timestamp format, such as yyyy-MM-dd HH:mm:ss.
string
Timezone in which supplied entry timestamps were recorded.
string
Timezone in which Zoho People should store the entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_ATTENDANCE_REGULARIZATIONSubmit an attendance regularization request using the documented legacy contract.

Input Parameters

object
required
Regularization details keyed by organization-formatted date; used by addData.
string ("Day" | "Week" | "Month")
Regularization period.
string
required
Last regularization date in organization format.
string
Create a regularization request.
string
required
First regularization date in organization format.
string
Employee record number; applicable to administrators.
string
Chosen approver record number when company settings require it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_COMPENSATORY_REQUESTCreate a V3 compensatory-off request.

Input Parameters

string ("Days" | "Hours")
required
Compensatory request unit.
string
Reason for the request.
string
required
For Days, FULL_DAY, HALF_DAY, or QUARTER_DAY; for Hours, HH:MM or a numeric number of hours.
string
Compensatory request expiry date.
string
required
Date on which the employee worked.
string
Worked end time in HH:MM format.
string
required
Employee Zoho record number.
string
Worked start time in HH:MM format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_EMPLOYEE_SALARYAdd a salary record for an employee.

Input Parameters

string
required
Date format used by the effective date, such as dd-MMM-yy.
string
JSON array of component rows. For salary creation this may be omitted; when salary structure is enabled, Zoho uses the selected package breakup.
string
required
JSON object containing employee, revised CTC, effective date, reason, and currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_FILE_FOLDERCreate a Zoho People V3 file folder.

Input Parameters

string
Request latitude.
string
Request longitude.
string
required
Name of the folder to create.
string
Parent folder ID, omitted for a root folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_FORM_RECORDCreate a record in a supported Zoho People form or create an employee record.

Input Parameters

boolean
Whether to save the general form record as a draft.
string
Initial password; required when is_direct_add is true.
string
required
JSON object of form label names and values accepted by the selected Zoho form.
boolean
Whether to add an employee profile without adding a user account.
string ("form_record" | "employee")
required
Select a general form record or the dedicated employee record contract.
boolean
Whether to add the employee directly with active status instead of sending an invitation.
Form link name; required only for record_type form_record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_HR_PROCESS_RECORDCreate a V3 HR process record for selected employees using documented process data.

Input Parameters

object
required
Typed process field values keyed by their Zoho field API names.
string
required
Reason for starting this HR process.
string
required
Zoho People HR process definition ID to start.
array
required
Zoho employee IDs for whom the process is created.
string
required
Effective date in the format configured for the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_JOB_SCHEDULECreate a legacy job schedule and optionally publish it.

Input Parameters

string
required
Schedule date in yyyy-MM-dd format.
string
required
Specify the Job Id
string
required
Schedule end time in 24-hour HH:mm format.
string
required
Schedule start time in 24-hour HH:mm format.
boolean
false | Specify if the job schedule needs to be repeated
boolean
false | Specify if the job schedule needs to be published
string
Specify the user for whom the job schedule needs to be added
string
Specify the description of the job schedule
string ("daily" | "weekly" | "monthly")
monthly> | Specify how often the job schedule should be repeated based on the repeat interval
string
Last date in the repeat series, in yyyy-MM-dd format.
integer ("1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12")
3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12> | Specify the interval for which the job schedule needs to be repeated
boolean
false | This key will be considered only if maximum log hours restriction is enabled in the settings. Specify true if the scheduled hours can exceed the maximum log hours configured in the settings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_LEAVE_GRANTCreate a V3 leave grant request.

Input Parameters

string
Reason for the grant request.
number
Number of days or hours to grant.
string
Grant leave type ID.
string
Employee Zoho record number.
string
Date from which the grant takes effect.
object
Supporting document with file_id, source, and file_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_LEAVE_REQUESTCreate a V3 leave request.

Input Parameters

object
Per-date leave count, session, and time details.
string ("Days" | "Hours")
required
Leave unit.
string
Reason for the leave request.
string
required
Leave end date.
string
required
Leave start date.
string
Approver Zoho record number when employees choose an approver.
string
Employee ID.
object
Custom leave-form field API names mapped to scalar values. Standard request parameter names are not allowed.
string
required
Leave type ID.
string
Employee Zoho record number.
string
Employee email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_LEAVE_SETTINGCreate a V3 holiday, pay-period policy, or work calendar using a closed typed contract.

Input Parameters

object
Per-date holiday count and session details.
string
Pay-period policy name.
string
Holiday end date.
string ("WEEKLY" | "MONTHLY" | "HALF_MONTHLY")
Pay-period frequency: WEEKLY, MONTHLY, or HALF_MONTHLY.
string
Holiday start date.
string ("holiday" | "pay_period_policy" | "work_calendar")
required
Setting type to create.
string
Holiday description.
string
Location ID for the work calendar.
string
Holiday name.
object
Custom calendar start and optional end date.
object
Email reminder template and lead days.
boolean
Use a custom calendar year.
string
First day of the work week.
array
Weekend pattern objects encoded by Zoho as a JSON array.
boolean
Notify employees through feeds.
array
Applicable shift IDs.
string
Day on which the pay period ends.
string
Payroll cutoff day.
array
Role IDs to which the policy applies.
array
Applicable location IDs.
boolean
Whether this is a restricted holiday.
array
Statutory weekend day names.
array
Location IDs to which the policy applies.
boolean
Lock attendance data on cutoff day.
object
Absence-to-leave conversion configuration.
boolean
Enable leave encashment processing.
string
Holiday classification ID.
string
Second payroll cutoff day for HALF_MONTHLY policies.
boolean
Reprocess leaves affected by this holiday.
string
Payroll report generation day.
array
Employment type IDs to which the policy applies.
string ("APPROVE" | "REJECT")
APPROVE or REJECT pending requests at cutoff.
string
Second report generation day for HALF_MONTHLY policies.
boolean
Apply location holidays to shift employees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_LEGACY_TIME_TRACKER_CLIENTCreate a client using the legacy time-tracker contract.

Input Parameters

string
Specify the city name
string
Specify the state name
string
Specify the fax number
string
Specify the country name (Example INDIA for India)
string
Specify the pin code
string
Specify the company size
string
required
Specify the currency code (Example INR for India)
string
Specify the email Id
string
Specify the industry name
string
Specify the phone number
string
Specify the last name
string
Specify the mobile number
string
Specify the first name
string
required
Specify the client name
string
Specify the description
string
Specify the street address
string
Optional hourly-job-rate mode using Zoho’s verified compact wire token. Omit this field to use the provider default. Zoho names other modes but does not publish their exact legacy wire tokens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_LMS_BATCHCreate a batch in a blended-learning Zoho People LMS course.

Input Parameters

string
required
Opaque blended-learning course ID.
object
required
Typed batch fields serialized as Zoho’s required batchData JSON string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_LMS_COURSECreate a Zoho People LMS course using the documented JSON contract.

Input Parameters

string
required
Course name.
integer
Course duration.
array
LMS category IDs assigned to the course.
string
Course code.
integer ("1" | "2" | "3")
required
Course type: 1 self-paced, 2 blended learning, or 3 e-material.
string
Course description.
string
Detailed overview of the course content.
array
Employee record numbers of course administrators.
string ("minute" | "hour" | "day")
Course duration unit: minute, hour, or day.
object
Enrollment and completion rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_LMS_MODULECreate a module through the documented self-paced course or blended-learning batch route.

Input Parameters

string ("self_paced_course" | "batch")
required
Use the self-paced course route or the blended-learning batch route.
string
Opaque LMS batch ID; required only when target is batch.
string
required
Opaque Zoho People LMS course ID.
object
required
Typed module fields serialized as Zoho’s required moduleData JSON string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_LMS_SESSIONCreate a session in a module of a blended-learning LMS batch.

Input Parameters

string
required
Session date; Zoho examples use DD-MM-YYYY.
string
required
Session name.
string
Opaque LMS room ID.
string
required
Opaque LMS batch ID.
string
required
End time in 12-hour clock format.
string
required
Opaque LMS course ID.
string
required
Opaque LMS module ID.
string
Provider-formatted lock date.
string
required
Start time in 12-hour clock format.
string
Session description.
string ("0" | "1")
required
Session type: 0 classroom or 1 e-learning.
string
required
Trainer employee record number.
string
Opaque LMS grade category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_ON_DUTY_REQUESTSubmit an on-duty request using the documented legacy contract.

Input Parameters

integer ("0" | "1")
required
Request unit: 0 days or 1 hours.
string ("Day" | "Week" | "Month")
On-duty period.
string
required
Last on-duty date in organization format.
string
Create an on-duty request.
string
required
First on-duty date in organization format.
object
required
On-duty details keyed by organization-formatted date.
string
required
Configured on-duty type ID.
string
Employee record number; applicable to administrators.
string
Chosen approver record number when required by settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_PERFORMANCE_LIBRARY_ITEMSCreate up to 20 competencies, KRAs, skills, or review questions.

Input Parameters

array
KRAs to create.
array
Skills to create.
string ("competencies" | "kras" | "skills" | "review_questions")
required
Library resource to create.
array
Review questions to create.
array
Competencies to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_SHIFT_MAPPINGMap a shift to one employee using the V3 multipart contract.

Input Parameters

string
Approver employee Zoho ID when employee-selected approvers are enabled.
string
Shift ID.
string
Shift name; mapping by name ignores existing mapping conflicts.
string
Mapping description.
string
Employee ID to map.
string
Last mapping date in the organization’s date format.
boolean
Map the shift despite existing mapping conflicts.
string
required
First mapping date in the organization’s date format.
boolean
Update attendance data based on the new shift.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_TIME_LOGCreate a legacy time log; supplying new project or job names also creates those resources.

Input Parameters

string
required
Employee-ID > | Specify the user for whom timelog needs to be added
string
Decimal-2.5 or Time format-2:30
string
To add the timer log
string
Existing job ID; provide this or job_name.
string
Time format-2:30PM or 14:30
string
Specifying job name will create a new job based on the form add permission of the user
string
Specify the client Id of the project if needed, will be considered only if projectName param is specified
string
Time format-2:30PM or 14:30
string
required
Work date in yyyy-MM-dd format, or in date_format when supplied.
string
Specify the workitem
string
Specify the project Id of the job if needed
string
Specify the client name of the project if needed, will be considered only if projectName param is specified
string
Caller-supplied company date format for work_date; defaults to yyyy-MM-dd.
string
Specify the description
string
Specifying project name will create a new project based on the form add permission of the user
string
Specify billable or non-billable status; Zoho’s example uses Billable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_TIMESHEETCreate a legacy timesheet from time logs and optionally submit it for approval.

Input Parameters

string
required
Specify the user for whom timesheet has to be created
string
all | Specify the job Id
string
required
Specify the to date
string
all | Specify the client Id
string
required
Specify the from date
object
Optional file to attach to the new timesheet.
string
all | Specify the project Id
string
Specify the format in which the dates should be provided
string
Specify the description
string
required
Specify the timesheet name
string ("billable" | "non-billable" | "all")
Select billable, non-billable, or all time logs.
boolean
false | To submit the timesheet for approval

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_VARIABLECreate a V3 Zoho People variable.

Input Parameters

string
required
Human-readable variable name, 2-100 characters using only letters, numbers, spaces, and underscores.
string ("text" | "textarea" | "email" | "number" | "currency" | "phone" | "checkbox" | "date" | "decimal" | "url" | "datetime")
required
Zoho variable datatype.
string
Initial value formatted for the selected datatype.
string
required
Stable API name for the variable, 2-100 characters using only letters, numbers, and underscores.
string
Optional variable description, up to 2000 characters.
object
required
Variable group identified by exactly one of id or api_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_CREATE_VARIABLE_GROUPCreate a V3 variable group.

Input Parameters

string
required
Human-readable variable-group name, 2-100 characters using only letters, numbers, spaces, and underscores.
string
required
Stable API name for the variable group, 2-100 characters using only letters, numbers, and underscores.
string
Optional variable-group description, up to 2000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_ATTENDANCE_ENTRIESDelete one V3 attendance entry by ID or a provider-supported filtered set of entries.

Input Parameters

string
Origin date in organization format.
string
Attendance entry ID; required for operation one.
string ("one" | "filtered_set")
required
Delete one entry by ID or a filtered employee/date set.
string
Employee Zoho ID for operation filtered_set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_ATTENDANCE_REGULARIZATIONSDelete one explicitly supplied attendance regularization record.

Input Parameters

string
required
Regularization record ID to delete; sent in Zoho’s recordId field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_COMPENSATORY_REQUESTDelete a V3 compensatory-off request by record ID.

Input Parameters

string
required
Compensatory request record ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_EMPLOYEE_PERFORMANCE_ITEMSPermanently remove selected tagged KRAs, competencies, or skills from an employee.

Input Parameters

string
required
Employee record identifier.
string ("kras" | "competencies" | "skills")
required
Tagged resource to remove.
array
required
Tagged assignment IDs to permanently remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_FILESPermanently delete up to 100 explicitly supplied Zoho People file IDs.

Input Parameters

string
Request latitude.
string
Request longitude.
array
required
File IDs to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_JOB_SCHEDULEDelete one legacy job schedule.

Input Parameters

integer ("1" | "2")
1 | This will be considered only if isDeleteRepeat is true. 1 - Delete current and the following schedules in the repeat series 2 - Delete all the schedules in the repeat series (allowed only for admin/data admin)
string
required
Specify the job schedule id to be deleted
boolean
false | If true, the repeat series will be deleted based on delRepeatType. If false, then only the mentioned schedule will be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_LEAVE_GRANTDelete a V3 leave grant request by record ID.

Input Parameters

string
required
Leave grant record ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_LEAVE_REQUESTDelete one V3 leave request by record ID.

Input Parameters

string
required
Leave request record ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_LEAVE_SETTINGDelete a V3 holiday, pay-period policy, or work calendar by ID.

Input Parameters

string ("holiday" | "pay_period_policy" | "work_calendar")
required
Setting type to delete.
string
Holiday ID for the holiday branch.
string
Pay-period policy ID for that branch.
string
Work calendar ID for that branch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_LEGACY_TIME_TRACKER_CLIENTDelete a client using the legacy time-tracker contract.

Input Parameters

string
required
Specify the client Ids (separated by commas). Note: Maximum number of Ids allowed is 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_LEGACY_TIME_TRACKER_RESOURCEDelete legacy projects or jobs using the selected documented contract.

Input Parameters

string
Specify the job Id (separated by commas). Maximum number of Ids allowed is 100.
string ("project" | "job")
required
Documented operation to execute.
string
Specify the projectIds (seperated by commas max count of 1000)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_ON_DUTY_REQUESTDelete explicitly supplied on-duty requests.

Input Parameters

array
required
On-duty record IDs to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_PERFORMANCE_LIBRARY_ITEMSRequest deletion of selected performance library records. Zoho’s success response is an acknowledgement and does not verify that each record was removed.

Input Parameters

array
required
Library record IDs for which Zoho should process a deletion request.
string ("competencies" | "kras" | "skills" | "review_questions")
required
Library resource to delete from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_SHIFT_MAPPINGDelete or end one V3 shift mapping with documented date and attendance options.

Input Parameters

string
required
Shift mapping ID to delete or end.
string
Approver employee Zoho ID when configured.
string
Shift ID.
string
Shift name.
string
Deletion or end-mapping description.
string
Employee ID.
string
Last affected date in the organization’s date format.
boolean
Apply despite mapping conflicts.
string
required
First affected date in the organization’s date format.
boolean
Update attendance data for the affected dates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_TIME_LOGDelete one legacy time log.

Input Parameters

string
required
Specify the timeLogId (seperated by commas).Note: Maximum number of IDs allowed is 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_TIMER_COMMENTDelete one legacy time-tracker comment.

Input Parameters

string
required
Specify the commentId to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_TIMESHEETDelete up to 1,000 comma-separated legacy timesheet IDs; fails loudly if Zoho skips any ID after partially deleting others.

Input Parameters

string
required
Specify the timesheet Ids (separated by commas). Maximum number of Ids allowed is 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_TIME_TRACKER_RESOURCESDelete the explicitly supplied V3 client, project, or job IDs.

Input Parameters

array
Job IDs to delete (maximum 200).
string ("clients" | "projects" | "jobs")
required
Documented operation to execute.
array
Client IDs to delete (maximum 200).
array
Project IDs to delete (maximum 200).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_VARIABLEDelete one V3 variable by numeric ID or API name.

Input Parameters

string
Variable-group ID or API name; required only for API-name deletion.
string
required
Variable ID or API name to delete.
string ("id" | "api_name")
required
Whether identifier is a numeric variable ID or a variable API name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DELETE_VARIABLE_GROUPDelete one V3 variable group by group ID or API name.

Input Parameters

string ("id" | "api_name")
required
Whether group_identifier is a group ID or API name.
string
required
Variable-group ID or API name to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DOWNLOAD_FILEDownload one Zoho People V3 file and return a file reference.

Input Parameters

string
required
ID of the file to download.
string
Request latitude.
string
Request longitude.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_DOWNLOAD_TIME_TRACKER_ATTACHMENTDownload one attachment from a documented time-tracker entity and return a file reference.

Input Parameters

string ("project" | "job" | "timelog" | "timesheet")
required
Type of parent record that owns the attachment.
string
required
ID of the project, job, time log, or timesheet that owns the attachment.
string
required
ID of the attachment to download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_ENROLL_LMS_LEARNERSCreate externally visible learner enrollments in a course or a specific blended-learning batch.

Input Parameters

string ("self_paced_course" | "batch")
required
Use the self-paced course route or the blended-learning batch route.
string
Opaque LMS batch ID; required only when target is batch.
string
required
Opaque Zoho People LMS course ID.
array
required
Employee record numbers serialized as Zoho’s required JSON array string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_ATTENDANCE_ENTRYFetch one V3 attendance entry by entry ID.

Input Parameters

string
Origin date in organization format, required when it is outside the current year.
string
required
Attendance entry ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_ATTENDANCE_REGULARIZATION_FIELDSReturn configured fields for attendance regularization requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_COMPENSATORY_REQUESTReturn one specific V3 compensatory-off request by record ID.

Input Parameters

string
required
Compensatory-off request record ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_FILEView one Zoho People V3 file and return a file reference.

Input Parameters

string
required
ID of the file to view.
string
Request latitude.
string
Request longitude.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_FILE_SHARING_OPTIONSReturn allowed folders or organization-file share targets.

Input Parameters

string ("allowed_folders" | "share_targets")
required
The documented sharing option to retrieve.
string
Request latitude.
string
Request longitude.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_FORM_FIELDSGet the field components and label names needed to read or write records in a Zoho People form.

Input Parameters

Form link name returned by List forms, such as employee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_FORM_RECORDFetch one form record, a section-wise record, or records from a saved employee view.

Input Parameters

string ("record" | "section_wise_record" | "employee_view_record")
required
Select the documented record lookup contract.
string
Zoho form record ID; required for record and section_wise_record lookups.
string
Saved employee view name; required for employee_view_record.
integer
One-based start index for the employee view lookup.
integer
Employee-view records to return, from 10 through 200.
string
Employee ID or email matched against search_column.
integer
Return employee-view records added or modified after this Unix timestamp in milliseconds.
string
Employee-view search column: EMPLOYEEID or EMPLOYEEMAILALIAS.
Form link name; required for record and section_wise_record lookups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_HOLIDAYFetch one V3 holiday by holiday ID.

Input Parameters

string
required
Holiday ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_HOURLY_PERMISSION_OPTIONSReturn applicable permission types, balance, or configured details for an hourly-permission request.

Input Parameters

string
Date in organization format for balance.
string
Permission form ID for details.
string ("applicable_types" | "balance" | "details")
required
Permission metadata to return.
string
Permission record ID for details.
string
Permission type ID for balance.
array
Active-user type IDs for details.
string
Employee record number for applicable types or balance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_HR_PROCESS_RECORDFetch one V3 HR process record by its documented record ID.

Input Parameters

string
required
Numeric Zoho People HR process record ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_LEAVE_GRANTFetch one V3 leave grant request by record ID.

Input Parameters

string
required
Leave grant record ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_LEAVE_REPORTReturn one page of a selected V3 or documented legacy leave report.

Input Parameters

string
Legacy report unit: Day or Hour.
string
Continuation cursor from a previous paginated report response.
string
V3 report end date.
string
Employee Zoho record number for the legacy user report.
string
V3 report start date.
string
End date for a legacy aggregate report.
string ("v3_leave_type_summary" | "legacy_user" | "legacy_booked_and_balance" | "legacy_encashment" | "legacy_loss_of_pay")
required
Documented report contract to run.
string
Start date for a legacy aggregate report.
string
Leave type ID for the V3 leave-type summary.
array
Legacy department IDs as a JSON array.
array
Legacy leave type IDs as a JSON array.
string
End date for the legacy user report.
array
V3 employee statuses: ACTIVE_USERS, ACTIVE_EMPLOYEE_PROFILES, EX_EMPLOYEES, or LOGIN_DISABLED.
array
V3 role IDs as a JSON array.
array
V3 employee Zoho record numbers as a JSON array.
string
Date format for the legacy loss-of-pay report.
array
Legacy employee Zoho record numbers as a JSON array.
array
V3 location IDs as a JSON array.
array
Legacy employee statuses: ACTIVE_USERS, ACTIVE_EMPLOYEE_PROFILES, EX_EMPLOYEES, or LOGIN_DISABLED.
array
V3 department IDs as a JSON array.
array
V3 designation IDs as a JSON array.
string
Legacy pay-period setting ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_LEAVE_REQUESTFetch one V3 leave request by record ID.

Input Parameters

string
required
Leave request record ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_LEAVE_SETTINGFetch one V3 pay-period policy or work calendar by ID.

Input Parameters

string ("pay_period_policy" | "work_calendar")
required
Setting type to fetch.
string
Pay-period policy ID for that branch.
string
Work calendar ID for that branch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_LEGACY_TIME_TRACKER_RESOURCEFetch one legacy client, project, or job by ID.

Input Parameters

string
Specify the job Id
string
Specify the client Id
string ("client" | "project" | "job")
required
Documented operation to execute.
string
Specify the project id of the project of which the details needs to be fetched
string
Specify the date format
boolean
false | To get the departments that are assigned to the project
boolean
false | To get the number of jobs mapped to the project
boolean
false | To get the number of users assigned to the project
boolean
This key fetches whether there is delete permission for the individual record.
boolean
false | To fetch the workItems that are assigned to the jobs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_LMS_SETTINGSReturn organization-level Zoho People LMS settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_MY_COMPENSATIONReturn compensation details for the connected employee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_ON_DUTY_DETAILSFetch details for one on-duty request.

Input Parameters

string
required
On-duty form ID.
string
required
On-duty record ID.
array
Active user and active non-user type IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_ORGANIZATIONReturn the connected Zoho People organization’s details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_PAY_PERIOD_SETTINGSReturn legacy payroll pay-period settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_RUNNING_TIMERReturn the connected user’s currently running time-tracker timer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_SHIFT_MAPPINGFetch one V3 shift mapping by mapping ID.

Input Parameters

string
required
Shift mapping ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_SHIFT_SCHEDULEReturn V3 shift schedules for an employee and date range.

Input Parameters

string
required
End date in the organization’s date format.
string
required
Start date in the organization’s date format.
string
Employee ID.
string
Employee email address.
string
Employee biometric mapper ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_SUGGESTED_LMS_COURSE_COUNTReturn the number of LMS courses suggested to the connected learner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_TIME_LOGFetch one legacy time log with optional timer and comment counts.

Input Parameters

string
required
Specify the time log id whose details need to be fetched
boolean
false | Set true to fetch the timer intervals if the time log is of type 2 (timer time log)
boolean
false | Set true to fetch the number of comments/notes added for the timer time log

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_TIMESHEETFetch one legacy timesheet by ID.

Input Parameters

string
Specify the format in which the dates should be provided
string
required
Specify the timesheet Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_TIME_TRACKER_REPORTS_AND_SETTINGSReturn a payroll report page, pay-period details, or general time-tracker settings.

Input Parameters

integer
Specify the number of records to be fetched. Maximum value is 100
string
Opaque payroll-report cursor returned by the previous call.
integer
Specify from which record the response should be fetched
string
Payroll range end in yyyy-MM-dd format, or in date_format when supplied.
string
Payroll range start in yyyy-MM-dd format, or in date_format when supplied.
string ("payroll_report" | "pay_period_details" | "general_settings")
required
Documented operation to execute.
string
Caller-supplied format for from_date and to_date; omit it for yyyy-MM-dd.
string
Used to fetch pay period details based on location Id
string
Email-ID | Employee-ID > | all | Specify the user whose payroll data needs to be fetched
string
Used to fetch pay period details based on location Name
string
Specify the pay period Id for which payroll data needs to be fetched
string ("approved" | "unapproved" | "all")
all > | all | Specify the approval Status based on which payroll data needs to be fetched
string ("all" | "users" | "employeeprofiles" | "exemployees" | "logindisabled")
employeeprofiles | exemployees | logindisabled> | all | Specify the employee status based on which payroll needs to be fetched
boolean
false | Used to get reportees, considered only when userErecno parameter value is all
boolean
false | Fetches ex-employees whose data of exit is on or after from date specified

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_TIME_TRACKER_RESOURCEFetch one V3 client, project, or job by ID with resource-specific include options.

Input Parameters

string
Provider value for job_id.
string
Provider value for client_id.
string ("client" | "project" | "job")
required
Documented operation to execute.
string
Provider value for project_id.
string
Specify the format in which the dates should be provided
boolean
Fetches the number of jobs mapped to the project
boolean
Fetches the number of users assigned to the project
boolean
To get the departments that are assigned to the project
boolean
Fetches the total hours logged for the jobs
boolean
This key fetches whether there is delete permission for the individual record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_VARIABLEFetch one V3 variable by numeric ID or API name.

Input Parameters

string
Variable-group ID or API name; required when identifier_kind is api_name.
string
required
Variable ID or API name selected by identifier_kind.
string ("id" | "api_name")
required
Whether identifier is a numeric Zoho variable ID or a variable API name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_GET_VARIABLE_GROUPFetch one V3 variable group by group ID or API name.

Input Parameters

string ("id" | "api_name")
required
Whether group_identifier is a group ID or API name.
string
required
Variable-group ID or API name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_ATTENDANCE_ENTRIESReturn one V3 page of attendance entries with employee, date, and modification filters.

Input Parameters

string
Opaque cursor returned by a previous call; pass it back unchanged.
string
End date in organization format; use with from_date instead of last_modified_within.
string
Start date in organization format; use with to_date instead of last_modified_within.
string
Employee ID.
string
Employee Zoho ID.
string
Employee email address.
integer
Return entries modified within this many minutes instead of filtering by date.
boolean
Group entries by date.
boolean
Group entries by employee, with date grouping nested when both grouping flags are true.
string
Employee biometric mapper ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_ATTENDANCE_REGULARIZATION_REASONSReturn configured reasons available for attendance regularization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_ATTENDANCE_REGULARIZATION_RECORDSReturn one page of attendance regularization records using documented filters.

Input Parameters

integer
Number of regularization records requested on this page.
string
Cursor returned by a previous call; omit for the first page.
integer ("-3" | "1" | "-1" | "0")
Regularization status filter. Zoho accepts only -3, 1, -1, or 0.
string
End date for the regularization search.
string
Start date for the regularization search.
string
Attendance regularization record ID filter.
string
Format used by from_date and to_date, such as yyyy-MM-dd.
string
Employee ID filter.
integer
Provider start index for this page.
string
Employee record number filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_COMPENSATION_REFERENCE_DATAReturn compensation components, packages, currencies, reasons, or settings.

Input Parameters

string ("active" | "inactive")
Enabled status filter for components or packages.
string ("components" | "packages" | "currencies" | "reasons" | "settings")
required
Compensation reference-data collection to return.
string
JSON array of location IDs for component or package filtering.
string ("benefit" | "ctc")
Component type; mandatory when filtering components by location.
string
JSON array of designation IDs for package filtering.
boolean
For currencies, return only the organization’s home currency when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_COMPENSATION_REVISIONSReturn one page of compensation revisions with date and status filters.

Input Parameters

string
Cursor returned by a previous call; omit for the first page.
string ("pending" | "processed" | "rejected" | "cancelled")
Approval status filter.
string
Latest revision creation or modification date.
string
Earliest revision creation or modification date.
integer
One-based starting revision index.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_COMPENSATORY_REQUESTSReturn one V3 page of compensatory-off requests with employee, date, approval, and status filters.

Input Parameters

string ("worked_date" | "-worked_date" | "expiry_date" | "-expiry_date" | "employee" | "-employee")
Sort field; prefix with ’-’ for descending order.
string
Continuation cursor from a previous response.
string
Worked-date range end.
string
Worked-date range start.
string ("MINE" | "SUBORDINATES" | "DIRECT_SUBORDINATES" | "MINE,SUBORDINATES" | "ALL")
Data ownership selection such as MINE, SUBORDINATES, or ALL.
array
Compensatory record statuses as a JSON-array filter.
string ("APPROVED" | "PENDING" | "REJECTED" | "CANCELLED" | "CANCEL_PENDING" | "ALL")
Approval status filter.
array
Employee statuses as a JSON-array filter.
array
Employee Zoho record numbers as a JSON-array filter.
array
Location IDs as a JSON-array filter.
array
Department IDs as a JSON-array filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_EMPLOYEE_PERFORMANCE_ITEMSReturn one page of an employee’s KRAs, competencies, or skills.

Input Parameters

integer
Maximum records to return, up to 200.
string
Opaque cursor returned by the previous page. Pass it unchanged.
string
Employee record identifier. Required on the first page.
string ("kras" | "competencies" | "skills")
Employee performance resource to list. Required on the first page.
boolean
For skills, whether to show skill revisions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_EMPLOYEE_SALARIESReturn one page of employee salary records for team or all visibility.

Input Parameters

string ("team" | "all")
required
Salary visibility mode: team or all.
string
Cursor returned by a previous call; omit for the first page.
integer
One-based starting salary record index.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_FILE_ACKNOWLEDGEMENTSReturn one acknowledgement-details page or user acknowledgement statuses.

Input Parameters

string ("details" | "user_status")
required
Acknowledgement view to retrieve.
integer
Maximum details to return.
integer
Start index returned by a previous details page.
string
File ID for acknowledgement details.
string
Employee record number for user status.
array
File IDs for user acknowledgement status.
string
Request latitude.
string
Request longitude.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_FILE_FOLDERSReturn all Zoho People V3 file folders matching an optional name.

Input Parameters

string
Optional folder or category name filter.
string
Request latitude.
string
Request longitude.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_FILESReturn one page from a documented Zoho People V3 file view.

Input Parameters

string ("all_files" | "folder" | "subfolder")
required
Documented file view to list.
integer
Maximum records to return, up to 200.
integer
Start index returned by the previous page.
string
Role ID filter.
string
Modified-through date in Zoho’s format.
string
Business unit ID.
string
Employee ID filter.
string
Request latitude.
integer ("0" | "1" | "2")
required
0 employee, 1 organization, or 2 personal files.
string
Folder ID filter.
string
Modified-from date in Zoho’s format.
string
Request longitude.
string
Organization entity ID.
string
Division ID.
string
Location ID filter.
integer ("1" | "3")
1 sorts by name; 3 sorts by modified time.
string
Department ID.
string
Employee record number for subfolder view.
string
Required parent folder ID for subfolder view.
boolean
Whether to sort descending.
string
File-name search text.
boolean
Whether to return only expired files.
string
File-extension filter.
string ("all" | "my" | "subordinates" | "allrole" | "myrole" | "inactiveemp" | "logindisabled" | "allsubordinates")
Employee-file view filter.
string ("location" | "entity" | "unit" | "division" | "department")
Organization hierarchy filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_FORM_RECORDSReturn one page of records from a named Zoho People form.

Input Parameters

string
Cursor returned by a previous call; omit for the first page.
integer
One-based starting record index.
string
Employee ID or email value matched against search_column.
integer
Return records added or modified after this Unix timestamp in milliseconds.
string
Employee search column, such as EMPLOYEEID or EMPLOYEEMAILALIAS.
Zoho form link name whose records are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_FORMSList forms and their identifiers, link names, views, visibility, and permissions in Zoho People.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_HOLIDAYSReturn one V3 page of holidays.

Input Parameters

string
Continuation cursor from a previous response.
string
Holiday range end date.
string
Holiday range start date.
array
Shift IDs as a JSON-array filter.
array
Location IDs as a JSON-array filter.
array
Holiday classification IDs as a JSON-array filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_HOURLY_PERMISSION_REQUESTSReturn one page of hourly-permission requests or approvals for the connected user’s role.

Input Parameters

string
Start-index cursor returned by a previous call.
string
Request end date in organization format.
string ("requests" | "approvals")
required
Connected-user requests or approvals requiring action.
string
Request start date in organization format.
integer ("-3" | "1" | "-1" | "0")
Approval status: -3 all, 1 approved, -1 pending, or 0 rejected.
array
Request approval statuses: 1 approved, -1 pending, or 0 rejected.
array
Employee record numbers for requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_JOB_SCHEDULESReturn one legacy page of job schedules by user and date range.

Input Parameters

string
Specify the user whose job schedule needs to be fetched
integer
Number of employee schedule groups to return; maximum 200.
string
Opaque cursor returned by the previous call.
integer
Zero-based first record offset.
string
required
Last schedule date in yyyy-MM-dd company-date format.
string
required
First schedule date in yyyy-MM-dd company-date format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_LEAVE_GRANTSReturn one V3 page of leave grant requests with employee, date, approval, and sort filters.

Input Parameters

string ("effective_date" | "-effective_date" | "leave_type" | "-leave_type" | "employee" | "-employee")
Sort field; prefix with ’-’ for descending order.
string
Continuation cursor from a previous response.
string
End date for grant records.
string
Start date for grant records.
string ("MINE" | "SUBORDINATES" | "DIRECT_SUBORDINATES" | "MINE,SUBORDINATES" | "ALL")
Data ownership selection such as MINE, SUBORDINATES, or ALL.
array
Leave type IDs as a provider JSON-array filter.
string ("APPROVED" | "PENDING" | "REJECTED" | "CANCELLED" | "CANCEL_PENDING" | "ALL")
Approval status filter.
array
Employee Zoho record numbers as a provider JSON-array filter.
array
Location IDs as a provider JSON-array filter.
array
Department IDs as a provider JSON-array filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_LEAVE_REQUESTSReturn one V3 page of leave requests with employee, date, type, approval, and status filters.

Input Parameters

string ("leave_type" | "-leave_type" | "employee" | "-employee" | "from_date" | "-from_date" | "to_date" | "-to_date")
Sort field; prefix with ’-’ for descending order.
string
Continuation cursor from a previous response.
string
required
End date for leave records.
string
required
Start date for leave records.
string ("MINE" | "SUBORDINATES" | "DIRECT_SUBORDINATES" | "MINE,SUBORDINATES" | "ALL")
Data ownership selection such as MINE, SUBORDINATES, or ALL.
array
Leave categories as a JSON-array filter.
array
Leave type IDs as a JSON-array filter.
string ("APPROVED" | "PENDING" | "REJECTED" | "CANCELLED" | "CANCEL_PENDING" | "ALL")
Approval status filter.
array
Employee statuses as a JSON-array filter.
array
Employee Zoho record numbers as a JSON-array filter.
array
Location IDs as a JSON-array filter.
array
Department IDs as a JSON-array filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_LEAVE_SETTINGSList V3 pay-period policies or work calendars.

Input Parameters

string ("pay_period_policies" | "work_calendars")
required
Setting collection to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_LEGACY_HOLIDAYSReturn holidays from the V2 all-holidays API using its employee, location, shift, and upcoming filters.

Input Parameters

string
Shift name filter.
string
Holiday range end date.
string
Employee ID, email address, or Zoho record number.
string
Location name filter.
boolean
Return holidays in the next 365 days.
string
Holiday range start date.
string
Format used by the from and to date values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_LEGACY_TIME_TRACKER_RESOURCESReturn one legacy page of clients, projects, or jobs with legacy filters.

Input Parameters

integer
Specify the number of records to be fetched. Maximum value is 200
string
Opaque cursor returned by the previous call.
integer
Specify from which record the response should be fetched
string
Specify the client Id to get the projects associated with it.
string ("clients" | "projects" | "jobs")
required
Documented operation to execute.
string ("all" | "in-progress" | "completed")
Legacy job status filter.
string
all | Specify the project Id which the jobs are associated with
string
all | Specify the user by whom the jobs are assigned
string
Email-ID | Employee-ID > | Specify the user whose projects should be listed.
string
Specify the format in which the dates should be provided
boolean
false | Fetches the number of jobs mapped to the project
boolean
false | Fetches the number of users assigned to the project
string ("all" | "inprogress" | "completed")
Legacy project status filter.
string
Email-ID | Employee-ID > | all | Specify the project manager
boolean
false | Fetches the total hours logged for the job
boolean
false | Fetches the number of users mapped to the job
string ("all" | "equal" | "notEqual" | "startsWith" | "endsWith" | "contains" | "notContains")
notEqual | startsWith | endsWith | contains | notContains | all | Specify the condition to get the projects whose names match the value given in ‘searchProjectKey’
string
Only the projects whose names match this value based on the condition given in ‘searchProject-Key’ will be listed (‘searchProject-Key’ must always accompany ‘searchProject-Name parameter)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_LMS_BATCH_SESSIONSFetch one page of sessions from a blended-learning LMS batch.

Input Parameters

string
Opaque cursor returned by the previous page. Pass it unchanged.
string
Opaque LMS batch ID. Required on the first page.
string
Opaque LMS course ID. Required on the first page.
integer
Zero-based first-page record index. Do not combine with cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_LMS_CATEGORIESReturn one page of Zoho People LMS course categories.

Input Parameters

string
Zero-based continuation startIndex; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_LMS_COURSESReturn one page of all LMS courses or the connected user’s courses with documented filters.

Input Parameters

string ("drafted" | "published" | "disabled")
Filter by course state.
Match course names containing this text.
string ("name" | "-name")
Sort course names ascending or descending.
string
Filter courses through this provider-formatted date or Unix epoch-millisecond value.
string ("all" | "mine")
required
Choose all visible courses or courses joined by the connected user.
string
Filter courses starting at this provider-formatted date or Unix epoch-millisecond value.
string
Filter by trainer ID.
string
Filter by category ID; Zoho also accepts MyfavouriteCategories.
integer ("1" | "2" | "3")
Filter by course type: 1 self-paced, 2 blended, or 3 e-material.
string
Opaque cursor from a previous response. Omit for the first page.
boolean
Filter to courses shared with the connected user.
boolean
Filter to courses suggested to the connected user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_LMS_MODULESFetch one page of modules from a self-paced course or a fixed blended-learning batch route.

Input Parameters

string
Opaque cursor returned by the previous page. Pass it unchanged.
string ("self_paced_course" | "batch")
Module collection to list. Required on the first page.
string
Opaque LMS batch ID; required for a batch on the first page.
string
Opaque LMS course ID. Required on the first page.
integer
Zero-based first-page record index. Do not combine with cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_LMS_ROOMSReturn one page of up to 25 rooms available for LMS sessions.

Input Parameters

string
Zero-based continuation startIndex; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_LMS_TRAINERSReturn one page of LMS trainers with employee-status and sort filters.

Input Parameters

string ("asc" | "desc")
Sort direction.
string
Opaque cursor from a previous response; omit for the first page.
string ("active" | "inactive")
Filter trainers by employee status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_ON_DUTY_REQUESTSReturn one page of on-duty requests or approvals for the connected user’s role.

Input Parameters

string
Start-index cursor returned by a previous call.
string
Request end date in organization format.
string ("requests" | "approvals")
required
Connected-user requests or approvals requiring action.
string
Request start date in organization format.
integer ("-3" | "1" | "-1" | "0")
Approval status: -3 all, 1 approved, -1 pending, or 0 rejected.
array
Request statuses in Zoho’s documented encoded set.
array
Employee record numbers for requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_ON_DUTY_TYPESReturn configured on-duty request types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_PERFORMANCE_LIBRARY_ITEMSReturn one page of competencies, KRAs, skills, or review questions.

Input Parameters

integer
Maximum records to return, up to 200.
string
Opaque cursor returned by the previous page. Pass it unchanged.
string ("competencies" | "kras" | "skills" | "review_questions")
Performance-library resource to list. Required on the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_SHIFT_MAPPINGSReturn one V3 page of employee shift mappings.

Input Parameters

string
Zero-based offset cursor returned by a previous call.
string
required
End date in the organization’s date format.
string
required
Start date in the organization’s date format.
string
Employee Zoho ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_TIME_LOGSReturn one legacy page of time logs with employee, project, job, date, billing, and approval filters.

Input Parameters

string
required
Email-ID | Employee-ID > | Specify user whose timelogs needs to be fetched
string
Specify the number of records to be fetched.Maximum value is 200
string
Continuation offset returned by the previous call.
string
Specify jobId for which timelogs needs to be fetched
string
Specify from which record the response should be fetched
string
Range end in yyyy-MM-dd or the company date format named by date_format.
string
Specify the client id for which timelogs needs to be fetched
string
Range start in yyyy-MM-dd or the company date format named by date_format.
string
Specify the project Id based on which timelogs needs to be fetched
string
Format used by from_date and to_date; defaults to the company’s date format.
string
Filter by billable, non-billable (also non billable or nonbillable), all, or the documented aliases 0, 1, and -1.
string ("approved" | "unapproved" | "all")
all > | all | Specify the approvalStatus based on which timelogs needs to be fetched
boolean
false | Fetches the comments count of the timer timelog

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_TIMESHEETSReturn one legacy timesheet page for a required user with documented status and date filters.

Input Parameters

string
required
Email ID, employee ID, employee record number, or all.
integer
Records to return; maximum 200.
string
Opaque cursor from the previous page.
integer
Zero-based first record offset.
string
End of the timesheet date range.
string
Start of the timesheet date range.
string
Format used by from_date and to_date.
string ("draft" | "pending" | "approved" | "rejected" | "all")
Timesheet approval status.
string ("users" | "nonusers" | "usersandnonusers" | "logindisabled")
Employee status to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_TIME_TRACKER_RESOURCESReturn one V3 page of clients, projects, or jobs with resource-specific filters.

Input Parameters

integer
Specify the number of records to be fetched. Maximum value is 200
string
Opaque cursor returned by the previous call.
integer
Specify from which record the response should be fetched
string
Employee-ID > String JSON Array | all | Specify the users by whom the jobs are assigned. The maximum number of Ids allowed is 10.
string ("clients" | "projects" | "jobs")
required
Documented operation to execute.
array
Specify the client Ids to get the projects associated with it. The maximum number of Ids allowed is 10.
string ("IN_PROGRESS" | "COMPLETED" | "all")
Job status. Use all to omit the filter and return every status.
string
Specify the format in which the dates should be provided
array
Specify the project Ids which the jobs are associated with. Maximum allowed is 1.
string
Only the clients whose names match this value based on the condition given in ‘search_match_type’ will be listed (‘search_match_type’ must always accompany ‘search_text’ parameter)
string
Employee-ID > String JSON Array | all | Specify the project heads. The maximum number of Ids allowed is 10.
string
Email-ID | Employee-ID > String JSON Array | current user | Specify the users whose projects should be listed. The maximum number of Ids allowed is 10.
string ("IN_PROGRESS" | "COMPLETED" | "all")
Project status. Use all to omit the filter and return every status.
string
Employee-ID > String JSON Array | all | Specify the project managers. The maximum number of Ids allowed is 10.
boolean
Fetches the number of jobs mapped to the project
string ("EQUAL" | "NOT_EQUAL" | "STARTS_WITH" | "ENDS_WITH" | "CONTAINS" | "NOT_CONTAINS")
STARTS_WITH | ENDS_WITH | CONTAINS | NOT_CONTAINS | CONTAINS | Specify the condition to get the clients whose names match the value given in ‘search_match_type’
boolean
Fetches the number of users assigned to the project
boolean
Fetches the total hours logged for the jobs
boolean
Specify whether to include client details of jobs or not

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_UNTAGGED_PERFORMANCE_ITEMSReturn one page of KRAs or competencies not tagged to selected employees.

Input Parameters

integer
Maximum records to return, up to 200.
string
Opaque cursor returned by the previous page. Pass it unchanged.
string ("kras" | "competencies")
Untagged performance resource to list. Required on the first page.
array
Employee record identifiers used for the untagged lookup. Required on the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_VARIABLE_GROUPSReturn one page of variable groups using the V3 index selector.

Input Parameters

integer
Zero-based provider start index.
string
Cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_VARIABLESReturn one page of variables using the V3 index selector.

Input Parameters

integer
Zero-based provider index at which to start returning variables.
string
Cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_VIEWSReturn the default and custom Zoho People views available to the connected user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_LIST_WORK_ITEMSReturn one legacy page of work items for an employee or job.

Input Parameters

string
Specify the number of records to be fetched. Maximum value is 200
string
Continuation offset returned by the previous call.
string
Specify the erecno of the employee
string
Specify the job ID
string
Specify from which record the response should be fetched
boolean
false | To fetch the default workItems

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_MARK_LMS_SESSION_ATTENDANCERecord Present or Absent for one learner in a completed LMS session; this externally visible attendance mutation is not a read operation.

Input Parameters

string ("Present" | "Absent")
required
Attendance value to record.
string
required
Opaque LMS batch ID.
string
required
Opaque LMS course ID.
string
required
Opaque LMS module ID.
string
required
Opaque LMS session ID.
string
required
Employee record number of the enrolled learner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_PUBLISH_LMS_RESOURCEPublish a self-paced course or blended-learning batch. This changes external learner visibility and can irreversibly notify applicable users.

Input Parameters

string ("self_paced_course" | "batch")
required
Use the self-paced course route or the blended-learning batch route.
string
Opaque LMS batch ID; required only when target is batch.
string
required
Opaque Zoho People LMS course ID.
boolean
Whether Zoho should notify applicable users. Batch publication defaults to true when omitted; the course page documents no default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_REMOVE_LMS_COURSE_LEARNERRemove one learner enrollment from a Zoho People LMS course.

Input Parameters

string
required
Opaque LMS course ID.
string
required
Opaque LMS learner ID returned by an enrollment operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_SEARCH_FORM_RECORDSReturn one page of employee form records matching a field, operator, and value.

Input Parameters

string
Cursor returned by a previous call; omit for the first page.
integer
One-based starting record index.
string
required
Pipe-separated Zoho search objects with searchField, searchText, optional searchOperator, and optional searchCriteria (AND or OR). Operators: True, False, Is, Is_Not, Is_Empty, Is_Not_Empty, Starts_With, Ends_With, Like, Contains, Not_Contains, Lesser_Than, Greater_Than, Lesser_than_or_equal_to, Before, Greater_than_or_equal_to, After, Between, Yesterday, Today, Tomorrow, Last_7_Days, Last_30_Days, Last_60_Days, Last_90_Days, Last_120_Days, Next_7_Days, Next_30_Days, Next_60_Days, Next_90_Days, Next_120_Days, Last_Month, This_Month, Next_Month, Current_and_Previous_Month, Current_and_Next_Month, Last_Year, This_Year, Next_Year, Last_2_Years, Next_2_Years, Current_and_Previous_Year, Current_and_Next_Year. searchOperator defaults to Contains and searchCriteria defaults to AND; Between takes two semicolon-separated searchText values. Example: {searchField:‘Employeestatus’,searchOperator:‘Is’,searchText:‘Active’,searchCriteria:‘AND’}|{searchField:‘Role’,searchOperator:‘Is’,searchText:‘Team Member’}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_SET_FILE_ACKNOWLEDGEMENTAcknowledge a Zoho People V3 policy file or revoke its acknowledgement.

Input Parameters

string
required
Policy file ID to acknowledge or revoke acknowledgement for.
string
Request latitude.
string
Request longitude.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_START_TIMERStart a legacy timer for a documented time-tracker item.

Input Parameters

string
required
Employee-ID > | Specify the current user’s value
string
Fixed start operation; injected when omitted.
string
required
Specify jobId for which timer needs to be started
string
required
Work date in yyyy-MM-dd or the company date format named by date_format.
string
Specify the workitem (maximum length is 500)
string
Specify the project Id based on which timer needs to be started
string
Format used by work_date; defaults to the company’s date format.
string
Specify the description(maximum length is 250)
string
required
Specify the billing status. Documented aliases include non billable, nonbillable, all, 0, 1, and -1; Zoho’s example uses Billable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_TAG_EMPLOYEE_PERFORMANCE_ITEMSTag up to 20 existing KRAs, competencies, or skills to one employee.

Input Parameters

array
KRAs to tag.
array
Skills to tag.
string
required
Employee record identifier.
string ("kras" | "competencies" | "skills")
required
Performance resource to tag.
array
Competencies to tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_ATTENDANCE_ENTRYEdit one V3 attendance entry by entry ID.

Input Parameters

string
Origin date in organization format when outside the current year.
string
required
Attendance entry ID.
string
Punch-in timestamp in the organization’s date-time format.
string
Punch-out timestamp in the organization’s date-time format.
string
Punch-in note.
string
Punch-out note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_COMPENSATORY_REQUESTEdit a V3 compensatory-off request by record ID.

Input Parameters

string ("Days" | "Hours")
required
Compensatory request unit.
string
Reason for the request.
string
required
For Days, FULL_DAY, HALF_DAY, or QUARTER_DAY; for Hours, HH:MM or a numeric number of hours.
string
required
Compensatory request record ID.
string
Compensatory request expiry date.
string
required
Date on which the employee worked.
string
Worked end time in HH:MM format.
string
required
Employee Zoho record number.
string
Worked start time in HH:MM format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_CURRENCIESUpdate one named compensation currency or multiple currencies.

Input Parameters

string
required
JSON object for one currency or JSON array for many; each entry needs currency_id and exchange_rate or format_type.
string ("one" | "many")
required
Select the documented single-currency or multi-currency update contract.
string
Currency ID in the single-currency endpoint path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_EMPLOYEE_PERFORMANCE_ITEMSUpdate an employee’s tagged KRAs, competencies, or skills.

Input Parameters

array
Tagged KRAs to update.
array
Tagged skills to update.
string
required
Employee record identifier.
string ("kras" | "competencies" | "skills")
required
Tagged resource to update.
array
Tagged competencies to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_EMPLOYEE_SALARYUpdate an employee salary record.

Input Parameters

string
required
Date format used by the effective date, such as dd-MMM-yy.
string
Optional JSON array of component rows for organizations with salary structure enabled; omit for employee-pay-only mode.
string
required
JSON object containing employee, revised CTC, effective date, reason, and currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_FILEUpdate a V3 file’s metadata or content and optionally send email or feed notifications.

Input Parameters

string
required
ID of the file to edit.
array
Role IDs for an employee file.
string
Request latitude.
string
Updated file name.
integer ("0" | "1" | "2")
0 employee, 1 organization, or 2 personal file.
string
Destination folder ID.
string
Request longitude.
string
New destination folder name.
boolean
required
Whether to send an email notification.
object
required
Required replacement file, up to 5000 KB.
string
File expiry date in Zoho’s date format.
boolean
Whether to send a feed notification.
boolean
Whether the edit originated from Zapier.
string
Updated description.
integer ("0" | "1" | "2")
required
Required view and download permission code: 0 enables both, 1 disables both, and 2 enables viewing only.
integer ("0" | "1" | "2")
Reporting-manager permission code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_FILE_FOLDERRename or move a Zoho People V3 file folder.

Input Parameters

string
Request latitude.
string
required
Folder ID to edit.
string
Request longitude.
string
required
New folder name.
string
New parent folder ID when moving the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_FORM_RECORDUpdate field values and optional tabular rows on an existing Zoho People form record.

Input Parameters

boolean
Whether to save the updated record as a draft.
string
required
Record ID returned by the form records API. Keep the full ID as a string.
object
required
JSON object mapping form label names to their replacement values.
object
JSON data for tabular-section rows to add, update, or delete.
Form link name containing the record, such as employee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_JOB_SCHEDULEEdit or publish a legacy job schedule using the selected operation.

Input Parameters

string
Replacement schedule date in yyyy-MM-dd format.
string
Specify the user whose job schedules needs to be published.
string
Specify the job id if the existing job needs to be modified
string
Specify the date till which the job schedule needs to be published.
string
Replacement end time in 24-hour HH:mm format.
string
Replacement start time in 24-hour HH:mm format.
string
Specify the date from which the job schedule needs to be published.
boolean
false | Specify true to repeat this job schedule (if isRepeat is true, then isEditRepeat should not be set as the complete series will be created afresh)
string ("edit" | "publish")
required
Documented operation to execute.
boolean
false | Specify true if the job schedule needs to be published
string
Specify the description if the existing needs to be modified
string ("daily" | "weekly" | "monthly")
monthly> | Specify how often the job schedule should be repeated based on the repeat interval
string
Last date in the replacement repeat series, in yyyy-MM-dd format.
boolean
false | Specify this key only when the job schedule in the repeat series has to be edited. true - Changes will be applied to the repeat series based on editRepeatType false - Only the mentioned schedule will be updated
string
Specify the job schedule id whose details needs to be modified
integer ("1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12")
3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12> | Specify the interval for which the job schedule needs to be repeated
integer ("1" | "2")
1 | This will be considered only if isEditRepeat is true. 1 - Changes will be applied to the current and the following schedules in the repeat series 2 - Changes will be applied to all the schedules in the repeat series (Allowed only for admin/data admin)
boolean
false | This key will be considered only if maximum log hours restriction is enabled in the settings. Specify true if the scheduled hours can exceed the maximum log hours configured in the settings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_LEAVE_GRANTEdit a V3 leave grant request by record ID.

Input Parameters

string
Reason for the grant request.
string
required
Leave grant record ID.
number
Number of days or hours to grant.
string
Grant leave type ID.
string
Employee Zoho record number.
string
Date from which the grant takes effect.
object
Supporting document with file_id, source, and file_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_LEAVE_SETTINGUpdate a V3 holiday, pay-period policy, or work calendar by ID using a closed typed contract.

Input Parameters

object
Per-date holiday count and session details.
string
Pay-period policy name.
string
Holiday end date.
string ("WEEKLY" | "MONTHLY" | "HALF_MONTHLY")
Pay-period frequency.
string
Holiday start date.
string ("holiday" | "pay_period_policy" | "work_calendar")
required
Setting type to update.
string
Holiday ID for the holiday branch.
string
Holiday description.
string
Holiday name.
object
Custom calendar year dates.
string
Pay-period policy ID for that branch.
object
Email reminder template and lead days.
boolean
Use a custom calendar year.
string
First day of the work week.
array
Weekend pattern objects encoded as a JSON array.
boolean
Notify employees through feeds.
string
Work calendar ID for that branch.
array
Applicable shift IDs.
string
Pay period end day.
string
Payroll cutoff day.
array
Applicable role IDs.
array
Applicable location IDs.
boolean
Whether this is a restricted holiday.
array
Statutory weekend day names.
array
Applicable location IDs.
boolean
Lock attendance data on cutoff day.
object
Absence-to-leave conversion configuration.
boolean
Enable leave encashment processing.
string
Holiday classification ID.
string
Second payroll cutoff day for HALF_MONTHLY policies.
boolean
Reprocess affected leaves.
string
Payroll report generation day.
array
Applicable employment type IDs.
string ("APPROVE" | "REJECT")
APPROVE or REJECT pending requests at cutoff.
string
Second report generation day for HALF_MONTHLY policies.
boolean
Apply location holidays to shift employees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_LEGACY_TIME_TRACKER_CLIENTUpdate a client using the legacy time-tracker contract.

Input Parameters

string
Specify the city name
string
Specify the state name
string
Specify the fax number
string
Specify the country name (Example INDIA for India)
string
Specify the pin code
string
Specify the company size
string
Specify the currency code (Example INR for India)
string
Specify the email Id
string
Specify the industry name
string
Specify the phone number
string
required
Specify the client Id
string
Specify the last name
string
Specify the mobile number
string
Specify the first name
string
Specify the client name
string
Specify the description
string
Specify the street address
string
Optional hourly-job-rate mode using Zoho’s verified compact wire token. Omit this field to keep the current method. Zoho names other modes but does not publish their exact legacy wire tokens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_LEGACY_TIME_TRACKER_STATUSChange a legacy project or job status.

Input Parameters

string
Specify the job Id
string ("inprogress" | "In-progress" | "Inprogress" | "completed")
Legacy project status: inprogress, In-progress, Inprogress, or completed.
string ("project" | "job")
required
Documented operation to execute.
string ("In-Progress" | "Completed")
Legacy job status to set.
string
Specify the project ID for which you would like to change the status

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_LMS_SESSIONUpdate fields on an existing blended-learning LMS session.

Input Parameters

string
Replacement date; Zoho examples use DD-MM-YYYY.
string
Replacement name.
string
Replacement opaque room ID.
string
required
Opaque LMS batch ID.
string
Replacement end time in 12-hour clock format.
string
required
Opaque LMS course ID.
string
required
Opaque LMS module ID.
string
Replacement provider-formatted lock date.
string
required
Opaque LMS session ID.
string
Replacement start time in 12-hour clock format.
string
Replacement description.
string ("0" | "1")
Replacement type: 0 classroom or 1 e-learning.
string
Replacement trainer employee record number.
string
Replacement opaque grade category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_PERFORMANCE_LIBRARY_ITEMSUpdate up to 20 competencies, KRAs, skills, or review questions.

Input Parameters

array
KRAs to update.
array
Skills to update.
string ("competencies" | "kras" | "skills" | "review_questions")
required
Library resource to update.
array
Review questions to update.
array
Competencies to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_TIME_LOGEdit one legacy time log.

Input Parameters

string
required
Employee-ID > | Specify the user
string
Decimal-2.5 or Time format-2:30
string
Specify the job Id if needed to be modified.
string
Time format-2:30PM or 14:30
string
Time format-2:30PM or 14:30
string
Replacement work date in yyyy-MM-dd format, or in date_format when supplied.
string
Specify the workitem
string
Specify the date format. If not specified, yyyy-MM-dd format will be taken
string
Specify the description
string
required
Specify the timelog Id whose details needs to be modified
string
Specify billable or non-billable status if needed; Zoho’s example uses Billable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_TIMESHEETEdit a legacy timesheet or replace its attachment. This action can irreversibly submit it for approval or permanently remove its attachment.

Input Parameters

object
Optional replacement file for the timesheet attachment.
string
Specify the description
string
required
Specify the timesheet Id
string
Specify the timesheet name
boolean
Set true to submit for approval. Submission changes workflow state and cannot be undone by this action.
boolean
Set true to permanently remove the current attachment. This cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_TIME_TRACKER_STATUSChange the status of one V3 project or job.

Input Parameters

string
Provider value for job_id.
string ("project" | "job")
required
Documented operation to execute.
string ("IN_PROGRESS" | "COMPLETED")
New job status.
string
Provider value for project_id.
string ("IN_PROGRESS" | "COMPLETED")
New project status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_VARIABLEUpdate one V3 variable by numeric ID or API name.

Input Parameters

string
Replacement variable name, 2-100 characters using only letters, numbers, spaces, and underscores.
string
Replacement value formatted for the variable datatype.
string
Replacement variable API name, 2-100 characters using only letters, numbers, and underscores.
string
required
Variable ID or API name to update.
string
Replacement variable description, up to 2000 characters.
object
Variable group identified by exactly one of id or api_name; required for API-name updates.
string ("id" | "api_name")
required
Select the documented ID route or API-name route.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPDATE_VARIABLE_GROUPUpdate one V3 variable group by group ID or API name.

Input Parameters

string
required
Replacement variable-group name, 2-100 characters using only letters, numbers, spaces, and underscores.
string
required
Replacement variable-group API name, 2-100 characters using only letters, numbers, and underscores.
string
Replacement group description, up to 2000 characters.
string ("id" | "api_name")
required
Whether group_identifier is a group ID or API name.
string
required
Variable-group ID or API name to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPGRADE_EMPLOYEE_SKILLSUpgrade a skill for selected employees, optionally attaching a certificate.

Input Parameters

string
required
Skill record ID.
array
required
Employee record identifiers whose skill will be upgraded.
object
Optional supporting certificate document.
string
Reason for the skill upgrade.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPLOAD_FILEUpload and optionally share a V3 file, notify people, or require acknowledgement by a deadline.

Input Parameters

array
Role IDs for an employee file.
string
Employee record number for an employee file.
string
Upload latitude.
string
required
Name to store for the file.
integer ("0" | "1" | "2")
0 employee, 1 organization, or 2 personal file.
string
Existing destination folder ID.
string
Upload longitude.
string
New destination folder name.
boolean
Whether to send an email notification.
object
required
File to upload, up to 5000 KB.
string
File expiry date in Zoho’s documented date format.
boolean
Whether to send a feed notification.
string
Optional file description.
integer ("0" | "1")
Set to 1 to require acknowledgement.
object
Organization entity names mapped to entity IDs for sharing.
string
Acknowledgement due date in Zoho’s date format.
integer ("0" | "1" | "2")
0 view/download, 1 neither, or 2 view only.
integer ("0" | "1" | "2")
Reporting-manager access code for employee files.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPLOAD_TIME_ATTENDANCE_FILEUpload an attachment for a documented time, attendance, or leave resource.

Input Parameters

object
required
Attachment to upload to Zoho People.
string ("leave_grant" | "leave_request" | "compensatory_request" | "attendance_entry" | "client" | "project" | "job")
required
Documented resource that will consume the returned local file ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_PEOPLE_UPSERT_LEGACY_FILE_FOLDERCreate or rename a legacy Zoho People file folder using its documented GET mutation.

Input Parameters

string
Existing folder ID to rename; omit to create.
string
required
New or replacement folder name.
string
Parent folder ID; omit to create a root folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not