Fetch Record API
This API is used to fetch all the records of a form based on view name, well as you can get records based on predefined columns.
Request URL
https://people.zoho.com/api/forms/P_EmployeeView/records?searchColumn=EMPLOYEEMAILALIASs&searchValue=johndoe@example.com
Header:
Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Scope:
ZOHOPEOPLE.forms.READ
Possible Operation Types:
READ - Read form data
Request Parameters
| PARAMETERS | VALUES ALLOWED | DEFAULT VALUE | PARAMETER DESCRIPTION | MANDATORY |
|---|---|---|---|---|
| viewName | - | To get the view name use Views API | Yes | |
| slindex | 1 | Starting Index | No | |
| rec_limit | 200 | Number of records to be fetched. Minimum value 10. | 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 |
Error Codes and Descriptions
| ERROR CODE | ERROR DESCRIPTION |
|---|---|
| 7012 | Invalid View Name |
| 7042 | Specified search value <searchvalue> is invalid |
Threshold Limit: 30 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/P_EmployeeView/records?searchColumn=EMPLOYEEMAILALIASs&searchValue=johndoe@example.comSample Response
Copied[
{
"Email address": "johndoe@example.com",
"Gender": "",
"recordId": "759415000001155233",
"createdTime": "1737516821876",
"Ask me about/Expertise": "",
"Employee Status": "Active",
"ownerID": "759415000001155233",
"Modified Time": "18-Apr-2025 17:27:27",
"Blood Group 1": "O -ve",
"Last Name": "Doe",
"Modified IP address": "125.17.68.205",
"Employee ID": "HRM02",
"Modified By": "Jane Doe",
"modifiedTime": "1744977447648",
"First Name": "John",
"Added Time": "22-Jan-2025 09:03:41",
"Zoho Role": "Team member",
"Added By": "Jane Doe",
}
]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/P_EmployeeView/records?searchColumn=EMPLOYEEMAILALIAS&searchValue=johndoe@example.com")
.get()
.addHeader("Authorization", "••••••")
.addHeader("Cookie", "CSRF_TOKEN=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zcsr_tmp=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zpsid=C9B0C2739FAE8B31975D2F7745237EFA; 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=C9B0C2739FAE8B31975D2F7745237EFA; zalb_c7cb34e6ac=15579241ea20d8d7fa5eb5f3fb79c37a");
const requestOptions = {
method: "GET",
headers: myHeaders,
redirect: "follow"
};
fetch("https://people.zoho.com/api/forms/P_EmployeeView/records?searchColumn=EMPLOYEEMAILALIAS&searchValue=johndoe@example.com", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));Copiedcurl --location 'https://people.zoho.com/api/forms/P_EmployeeView/records?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=C9B0C2739FAE8B31975D2F7745237EFA; zalb_c7cb34e6ac=15579241ea20d8d7fa5eb5f3fb79c37a'CopiedinputMap = Map();
inputMap.put("searchColumn","EMPLOYEEMAILALIAS");
inputMap.put("searchValue","johndoe@example.com");
AuthMap = Collection();
AuthMap.insert("Authorization":"••••••");
response = invokeUrl
[
url: "https://people.zoho.com/api/forms/P_EmployeeView/records"
type: GET
parameters: inputMap
headers: AuthMap.toMap()
];
info response;Copiedimport requests
url = "https://people.zoho.com/api/forms/P_EmployeeView/records?searchColumn=EMPLOYEEMAILALIAS&searchValue=johndoe@example.com"
payload = {}
headers = {
'Authorization': '••••••',
'Cookie': 'CSRF_TOKEN=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zcsr_tmp=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zpsid=C9B0C2739FAE8B31975D2F7745237EFA; zalb_c7cb34e6ac=15579241ea20d8d7fa5eb5f3fb79c37a'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)Show full
Show less