Specify true to tag an employee confidential file

Get the filepath from upload file and specify

Specify 1 to add Company File (or) Specify 0 to add Hr File

Specify true to tag isreportingto option if reporting can see his/her subordinates files

Specify true to the notifyToall option to sent an email

Specify 1 to get Company Files (or)   Specify 0 to get Hr Files

fileType

start

limit

roleId

catId

employeeId

locationId

Specify the filter like shown as ('all''my''subordinates''allrole''myrole')

filterBy

Apart from individually Adding and Uploading files

Specify 0 to make Company Files downloadable or Specify 1 to make Company Files non-downloadbale

Specify 0 to make HR Files viewable for Employee or Specify 1 to make HR Files non-viewable for Employee

This API is used to add or edit folders in the file modules of Zoho People

newCatName

Enter parent folder id if the new folder must be placed under an existing folder

parentCatId

Enter the folder Id of the folder that needs to be renamed

Email IDs to send notification (multiple emails can be separated with comma)

Expiry date of the Announcement given in specified format

if true is given then adding comment is disabled for the user; if false is given then adding comment is enabled for the user

if true is given then it is added as a sticky announcement; if false is given then it is added as an announcement

if true is given - mail notification will be sent to the people in the given locations/ if locations is not given, the mail notification will be sent to all locations; if false is given - no email notification is sent

if true is given then all the sticky announcements are fetched; if false is given then all the announcements are fetched

isSticky

keyword given is searched from the 10 records (from the given starting index)

startIdx

To fetch a particular announcement using its unique announcement ID

ID of the single announcement to be fetched

if 1 is given and isSticky is true and Locations is given - then all enabled sticky announcements of the given location will be filtered if 0 is given and isSticky is true and Location is given then all disabled sticky announcements of the given location will be filtered

if true is given then all the sticky announcements are filtered; if false is given then all announcements are filtered

Announcements of the location mentioned is filtered; if param not given then all location announcements are filtered

To delete a posted announcement using API. This will delete all data pertaining to an announcement

To enable or disable an announcement. Disabling an announcement will retain related data and so the announcement can be enabled when required

ID of the announcement to be   enabled/disabled

ID of the announcement for which comment is to be added

This API is used to bulk import the check-in and check-out details of the employees

This API fetches the latest attendance entries with Regularisation entries that has been added/updated within the latest minutes(given in param)

Duration in minutes within which the latest entries should be fetched

duration

Format of the date and time of Attendance entries in response is returned

dateTimeFormat

This API can be used to capture the check-in and check-out entries of an individual employee

Specify the check-out time of an employee

This API is used for getting the employee attendance entries

Specify the date in organisation date format

This API is used to get attendance details of employees from the attendance reports page

Specify the date format for the given date

Single Attendance Record - User Report API

This API is used to map employees to respective shifts

This API is used to fetch the shift configuration details of an employee

mapId

emailId

empId

sdate

edate

This API is used for fetching multiple records of regularization requests raised within a given data range

fromdate

todate

Specify the date format for the date given

dateFormat

startIndex

recordId

index

String of status IDs separated by (,) comma

status

categoryId

query

Employee record IDs separated by (,) comma

requestorErecno

Send single time limit(Today - 0, Yesterday - 1, Past 7 days - 2, Past 30 days - 3)

periodOfTime

This API is used to list categories that a user case raise query to

authtoken

subject

description

This API is used to fetch bulk records along with its tabular section details from particular forms. (maximum:200 records per api calls)

sIndex

number of records to be fetched in the current request

SearchColumn

Search Employeeid of the employee or the Employee MailID

SearchValue

To fetch records added & modified after the given time

modifiedtime

Employees can be added to the Organisation using Insert Record API itself

nput data for employee record in JSON format

true or false. If true is sent, the user will be added as an employee with active status  in the system

true or false. If true is sent, the user will be added as an employee profile in the system

You can add various departments one by one in Zoho People using the API below

This API is used to retrieve the list of forms and its details available in your Zoho People account

This API will display the record of a specific form indexed using a Record ID

form_link_name

formLinkName

Specifies the record Id of the record being fetched

This API will fetch all the record of a specific form indexed using a Record ID by section-wise

This API will retrieve records based on lookup Record ID

To get formLinkName, you can use Fetch Forms API

Related records to the parent module will be fetched

parentModule

Records will be retrieved related to this lookup field

lookupfieldName

This API is used to fetch all the records of a form based on the record values

viewName

rec_limit

searchField

Search any record using the operators (Eg- Is, Contains,)

searchOperator

Search any text that belongs to the record

searchText

Use Fetch Component API to retrieve the list of field components available in a form with ID

Refer Appendix Point 1, to know how to get the formLinkname of the form

This API is used to create assignments in module of course or batch in LMS 

course_id

module_id

Specify if late submissions is allowed or not

This API is used to update assignments in module of course or batch in LMS 

This API is used for fetching assignment in module of course or batch in LMS

Specify from which record the response should be fetched

This API is used to delete assignment in module of course or batch in LMS

assignment_id

This API is used to fetch assignment details in LMS

This API is used to update marks in LMS assignments

learnerErecno

marks

This API is used to create a new batch in LMS

batch_id

Specify if wait-listing should be allowed or not

Cancel Batch When Minimum Capacity Is Not Met

This API is used to update batch details in LMS

This API is used to delete a batch in LMS

This API is used to fetch a single batch in LMS

This API is used for fetching the list of batches in a course in LMS

This API is used to publish a batch in LMS

This API is used to unpublish a batch in LMS

This API is used to mark a batch as completed in LMS

This API is used to mark a batch as incomplete in LMS

This API is used to create a new batch scheduler in LMS

Specify the days of the week from 1- 7 which represents sunday to saturday

Specify the month of the year which represents January to December

Specify the value for waiting time unit for cancellation

Specify the week of the month which represents the first to fifth week

This API is used to fetch batch schedulers list in LMS

This API is used to update batch scheduler in LMS

batch_scheduler_id

This API is used to delete a batch scheduler in LMS

This API is used to fetch a batch scheduler in LMS

This API is used for fetching categories in LMS

Specify from which record the response must be fetched

This API is used for fetching content details in LMS

contentId

This API is used for fetching conents in modules of courses or batches in LMS

This API is used for fetching contents of courses or batches in LMS

This API is used to publish courses in LMS

This API is used to unpublish courses in LMS

This API is used to enable courses in LMS

This API is used to disable courses in LMS

This API is used to mark a course as favourite in LMS

This API is used to unmark a course as favourite in LMS

This API is used to removed shared user from courses in LMS

sharedUserErecno

This API is used to get course shared users list in LMS

This API is used to suggest a course in LMS

This API is used to get suggested course count in LMS

This API is used to enroll learner to a course in LMS

This API is used to enroll learner to a batch in LMS

This API is used to unenroll learner from a course in LMS

This API is used to unenroll learner from a batch in LMS

This API is used to remove learner from a course in LMS

learner_id

This API is used to remove learner from a batch in LMS

This API is used for creating new courses in LMS

Specify what is covered in the course along with the details on the content of the course

This API is used for updating courses in LMS

This API is used to fetch all courses info in LMS

Specify the string to check match with course name

search

type

trainerId

state

sortBy

startDate

endDate

sharedToMe

suggestedToMe

This API is used to delete courses in LMS

This API is used to fetch single course info

Specify the batch for blended learning course

batchId 

This API is used to fetch all the courses that you have joined

The purpose of the API is to list the course entities that are required to be completed in order to unlock the current course entity

locked_entity_id

This API is used to create files in modules of courses or batches in LMS

Specify if the file can be downloaded or not

This API is used for fetching files in modules of course/batches in LMS

This API is used to update files in modules of courses or batches in LMS