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.READ
Possible Operation Types:
CREATE - Read form data
Request Parameters:
| PARAMETERS | VALUES ALLOWED | DEFAULT VALUE | PARAMETER DESCRIPTION | MANDATORY |
|---|---|---|---|---|
| formLinkName | - | - | - | No |
| slIndex | 1 | - | starting index of the records to fetch (record index starts from 1) | No |
| limit | 200 | - | number of records to be fetched in the current request (maximum 200 records) | No |
| SearchColumn | - | - | Search EMPLOYEEID or EMPLOYEEMAILALIAS | No |
| SearchValue | - | - | Search Employeeid of the employee or the Employee MailID | No |
| modifiedtime | Timestamp | - | To fetch records added & modified after the given time . value should be timestamp in milliseconds | No |
Common Error Codes and Descriptions
| ERROR CODE | ERROR DESCRIPTION |
|---|---|
| 7011 | Form name '<formLinkName>' is invalid |
| 7021 | Maximum record limit 200 is exceeded |
| 7042 | Specified search value <searchvalue> is invalid |
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.
Sample Request
Copiedhttps://people.zoho.com/api/forms/employee/getRecords?searchColumn=EMPLOYEEMAILALIAS&searchValue=johndoe@example.comSample Response
Copied{
"response": {
"result": [
{
"759415000001155233": [
{
"EmailID": "johndoe@example.com",
"ModifiedBy": "Jane Doe",
"Employeestatus": "Active",
"Role.ID": "759415000000035635",
"Zoho_ID": 759415000001155233,
"Blood_Group_1": "O -ve",
"FirstName": "John",
"Mobile": "XX-YYYY",
"ModifiedBy.ID": "759415000000240001",
"AddedTime": "22-Jan-2025 09:03:41",
"tabularSections": {
"Work experience": [
{
"Jobtitle": "Develper",
"Employer": "",
"RELEVANCE": "",
"Previous_JobDesc": "",
"FromDate": "",
"Todate": "",
"tabular.ROWID": "759415000001294003",
"RELEVANCE.id": ""
}
],
},
"AddedBy": "Jane Doe",
"AddedBy.ID": "759415000000240001",
"LastName": "Doe",
"EmployeeID": "HRM02",
"ModifiedTime": "1744977447648",
}
]
}
],
"message": "Data fetched successfully",
"uri": "/api/forms/employee/getRecords",
"status": 0
}
}Show full
Show less
CopiedOkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
Request request = new Request.Builder()
.url("https://people.zoho.com/api/forms/employee/getRecords?searchColumn=EMPLOYEEMAILALIAS&searchValue=johndoe%40example.com")
.get()
.addHeader("Authorization", "••••••")
.addHeader("Cookie", "CSRF_TOKEN=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zcsr_tmp=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zpsid=4109D5890160E69734F048B1ACA0881B; zalb_c7cb34e6ac=15579241ea20d8d7fa5eb5f3fb79c37a")
.build();
Response response = client.newCall(request).execute();Copiedconst myHeaders = new Headers();
myHeaders.append("Authorization", "••••••");
myHeaders.append("Cookie", "CSRF_TOKEN=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zcsr_tmp=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zpsid=4109D5890160E69734F048B1ACA0881B; zalb_c7cb34e6ac=15579241ea20d8d7fa5eb5f3fb79c37a");
const requestOptions = {
method: "GET",
headers: myHeaders,
redirect: "follow"
};
fetch("https://people.zoho.com/api/forms/employee/getRecords?searchColumn=EMPLOYEEMAILALIAS&searchValue=johndoe%40example.com", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));Copiedcurl --location 'https://people.zoho.com/api/forms/employee/getRecords?searchColumn=EMPLOYEEMAILALIAS&searchValue=johndoe%40example.com' \
--header 'Authorization: ••••••' \
--header 'Cookie: CSRF_TOKEN=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zcsr_tmp=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zpsid=4109D5890160E69734F048B1ACA0881B; zalb_c7cb34e6ac=15579241ea20d8d7fa5eb5f3fb79c37a'CopiedinputMap = Map();
inputMap.put("searchColumn","EMPLOYEEMAILALIAS");
inputMap.put("searchValue","johndoe%40example.com");
AuthMap = Collection();
AuthMap.insert("Authorization":"••••••");
response = invokeUrl
[
url: "https://people.zoho.com/api/forms/employee/getRecords"
type: GET
parameters: inputMap
headers: AuthMap.toMap()
];
info response;Copiedimport requests
url = "https://people.zoho.com/api/forms/employee/getRecords?searchColumn=EMPLOYEEMAILALIAS&searchValue=johndoe%40example.com"
payload = {}
headers = {
'Authorization': '••••••',
'Cookie': 'CSRF_TOKEN=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zcsr_tmp=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zpsid=4109D5890160E69734F048B1ACA0881B; zalb_c7cb34e6ac=15579241ea20d8d7fa5eb5f3fb79c37a'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)Show full
Show less