Get Bulk Records API
Purpose:
This API is used to fetch bulk records along with its tabular section details from particular forms. (maximum:200 records per api calls)
Request URL:
https://people.zoho.com/people/api/forms/<formLinkName>/getRecords?sIndex=<record starting index>&limit=<maximum record to fetch>
Header:
Authorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf
Scope:
scope=ZOHOPEOPLE.forms.ALL
or
scope=ZOHOPEOPLE.forms.READ
Possible Operation Types:
ALL - Full access to data
CREATE - Read form data
Request Parameters:
| sIndex | starting index of the records to fetch (record index starts from 1) |
| limit | number of records to be fetched in the current request (maximum 200 records) |
| SearchColumn | Search EMPLOYEEID or EMPLOYEEMAILALIAS |
| SearchValue | Search Employeeid of the employee or the Employee MailID |
| modifiedtime | To fetch records added & modified after the given time . value should be timestamp in milliseconds |
Threshold Limit: 400 requests | Lock period: 5 minutes
Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.
Request:
Here employee is the form name, sIndex is to fetch from 1st employee and maximum of 100 records per api call to fetch next set of 100 records , please provide sIndex=101 and limit=100
Copiedhttps://people.zoho.com/people/api/forms/employee/getRecords?sIndex=1&limit=100Request 2 - For searching records of a particular employee
Copiedhttps://people.zoho.com/api/forms/employee/getRecords?searchColumn=EMPLOYEEMAILALIAS&searchValue=charless@zykler.comHeader
CopiedAuthorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxfSample Response
Copied{"response":{"result":[{"567198000000239001":[{"EmailID":"steves@cross.org","CreatedTime":"1575547717392","Address":"","Date_of_birth":"","Photo":"https://contacts.zoho.com/file?ID=702414538&fs=thumb","AddedTime":"05-Dec-2019 17:38:37","Marital_status":"","Gender":"","ModifiedBy":"1 - shyam - sundar","ApprovalStatus":"Approval Not Enabled","Second_Reporting_To":"","Department":"","LocationName.ID":"","tabularSections":{"Education":[{}],"Work experience":[{}],"Dependent":[{}]},"AddedBy":"1 - shyam - sundar","Tags":"","Reporting_To":"","Photo_downloadUrl":"https://contacts.zoho.com/file?ID=702414538&fs=thumb","Employeestatus":"Active","Role":"Team member","Experience":"0","Employee_type":"","AddedBy.ID":"567198000000159005","Role.ID":"567198000000035635","LastName":"ilamaran","EmployeeID":"467","ZUID":"702414538","Current_Job_Description":"","Dateofexit":"","Second_Reporting_To.ID":"","Other_Email":"","Work_location":"","LocationName":"","Nick_Name":"","ModifiedTime":"1575548166777","Reporting_To.MailID":"","Zoho_ID":567198000000239001,"Designation.ID":"","Source_of_hire":"","Age":"0","Designation":"","FirstName":"surya","Dateofjoining":"","AboutMe":"","Mobile":"","Extension":"","ModifiedBy.ID":"567198000000159005","Reporting_To.ID":"","Work_phone":"","Department.ID":"","PAN":"","Expertise":""}]},{"567198000000232999":[{"EmailID":"it303@zohoapiuser.tk","CreatedTime":"1575030068748","Address":"","Date_of_birth":"","Photo":"https://contacts.zoho.com/file?ID=701806810&fs=thumb","AddedTime":"29-Nov-2019 17:51:08","Marital_status":"","Gender":"","ModifiedBy":"1 - shyam - sundar","ApprovalStatus":"Approval Not Enabled","Second_Reporting_To":"","Department":"","LocationName.ID":"","tabularSections":{"Education":[{}],"Work experience":[{}],"Dependent":[{}]},"AddedBy":"1 - shyam - sundar","Tags":"","Reporting_To":"","Photo_downloadUrl":"https://contacts.zoho.com/file?ID=701806810&fs=thumb","Employeestatus":"Active","Role":"Team member","Experience":"0","Employee_type":"","AddedBy.ID":"567198000000159005","Role.ID":"567198000000035635","LastName":"LastName303","EmployeeID":"IT303","ZUID":"701806810","Current_Job_Description":"","Dateofexit":"","Second_Reporting_To.ID":"","Other_Email":"","Work_location":"","LocationName":"","Nick_Name":"","ModifiedTime":"1575030068748","Reporting_To.MailID":"","Zoho_ID":567198000000232999,"Designation.ID":"","Source_of_hire":"","Age":"0","Designation":"","FirstName":"Name 303","Dateofjoining":"","AboutMe":"","Mobile":"","Extension":"","ModifiedBy.ID":"567198000000159005","Reporting_To.ID":"","Work_phone":"","Department.ID":"","PAN":"","Expertise":""}]}],"message":"Data fetched successfully","uri":"/api/forms/employee/getRecords","status":0}}