Get Related Records API

This API will retrieve records based on lookup Record ID.

Request URL:

https://people.zoho.com/people/api/forms/<formLinkName>/getRelatedRecords?sIndex=<sIndex>&limit=<limit>& parentModule=<parentModule>&id=<id>&lookupfieldName=<lookupfieldName>

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Scope:

ZOHOPEOPLE.forms.ALL
OR
ZOHOPEOPLE.forms.READ

Possible Operation Types:

ALL - Complete access to data
READ - Read form data

Request Parameters:

formLinkName	To get formLinkName, you can use Fetch Forms API.
sIndex	Starting index
limit	Number of records to be fetched
parentModule	Related records to the parent module will be fetched
id	Get related records based on record id
lookupfieldName	Records will be retrieved related to this lookup field

Note: If lookupfieldName is not given, primary lookup of the form will be taken as input.

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.

Request

Copiedhttps://people.zoho.com/people/api/forms/employee/getRelatedRecords?parentModule=department&id=3000000032001

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Json XML

Copied{"response":{"message":"Data fetched successfully","result":[{"tabularSections":{},"Department Details":{"Department_Lead":"charless charless 1","Parent_Department":"","Department":"People","MailAlias":"charless@zohocopr.com}}],"status":0,"uri":"/api/forms/department/getRecordByID"}}{
"response": {
"message": "Data fetched successfully",
"result": [
{ "3000000020481": [
{ "tabularSections": {
"Education": [
{ "Yearofgraduation": "2013",
"Education_AdditionalNotes": "",
"Degree": "B.Tech",
"Specialization": "CSE",
"Interests": "",
"College": "IIT"
} ], "Dependent": [
{ "Name": "Abhi",
"DependentDOB": "19-Sep-1997",
"DependentRelationship": "Brother"
}, { "Name": "fatima",
"DependentDOB": "15-Oct-1989",
"DependentRelationship": "Sister"
} ] }, "Basic Info": {
"EmployeeID": "12",
"Nick_Name": "",
"Decision_box_1": "false",
"FirstName": "charless",
"LastName": "charless",
"EmailID": "charless@zohocorp.com"
}, "Work": {
"Extension": "",
"Work_location": "",
"Role.ID": 3000000015529,
"Work_phone": "",
"Role": "Admin",
"Department": "People",
"Department.ID": 3000000032001,
"Employeestatus": "Active"
}, "Personal": {
"Tags": "",
"Date_of_birth": "04-Oct-1991",
"Address": "",
"Mobile": "",
"Other_Email": ""
}, "Summary": {
"Current_Job_Description": "",
"Expertise": "",
"Weddingday": "12-Oct-1985",
"AboutMe": ""
} } ] }, { "3000000020509": [
{ "tabularSections": {
"Education": [],
"Dependent": []
}, "Basic Info": {
"EmployeeID": "2",
"Nick_Name": "",
"Decision_box_1": "true",
"FirstName": "charless",
"LastName": "charless",
"EmailID":
"charless@zohocorp.com"
}, "Work": {
"Reporting_To.ID": 3000000020481,
"Extension": "",
"Work_location": "",
"Role.ID": 3000000015533,
"Work_phone": "",
"Role": "Team member",
"Department": "People",
"Department.ID": 3000000032001,
"Reporting_To": "charless charless 12",
"Employeestatus": "Active"
}, "Personal": {
"Tags": "",
"Date_of_birth": "11-Sep-1987",
"Address": "",
"Mobile": "",
"Other_Email": ""
}, "Summary": {
"Current_Job_Description": "",
"Expertise": "",
"AboutMe": ""
} } ] } ], "status": 0,
"uri": "/api/forms/employee/getRelatedRecords"

Copied<?xml version="1.0" encoding="UTF-8"?> <response uri="/api/forms/employee/getRelatedRecords">
<status>
0</status>
<message>
Data fetched successfully</message>
<result>
<3000000020481>
<tabularSections>
<section name="Education">
<row count="0">
<field name="Yearofgraduation">
2013</field>
<field name="Education_AdditionalNotes"></field> <field name="Degree">B.Tech</field>
<field name="Specialization">CSE</field> <field name="Interests">
</field>
<field name="College">
IIT</field>
</row>
</section>
<section name="Dependent">
<row count="0">
<field name="Name">
Abhi</field>
<field name="DependentDOB">
19-Sep-1997</field>
<field name="DependentRelationship">
Brother</field>
</row>
<row count="1">
<field name="Name">fatima</field>
<field name="DependentDOB">15-Oct-1989</field> <field name="DependentRelationship">
Sister</field>
</row>
</section>
</tabularSections>
<section name="Work">
<field name="Extension">
</field>
<field name="Work_location">
</field>
<field name="Role.ID">3000000015529</field>
<field name="Work_phone">
</field>
<field name="Role">
Admin</field>
<field name="Department">
People</field>
<field name="Employeestatus">
Active</field>
<field name="Department.ID">
3000000032001</field>
</section>
<section name="Basic Info">
<field name="Nick_Name">
</field>
<field name="EmployeeID">12</field> <field name="Decision_box_1">false</field> <field name="FirstName">
charless</field>
<field name="LastName">
charless@zohocorp.com</field>
</section> <section name="Summary">
<field name="Current_Job_Description">
</field>
<field name="Expertise">
</field>
<field name="Weddingday">
12-Oct-1985</field>
<field name="AboutMe">
</field>
</section>
<section name="Personal">
<field name="Tags">
</field>
<field name="Date_of_birth">04-Oct-1991</field>
<field name="Address">
</field>
<field name="Other_Email">
</field>
<field name="Mobile"></field> </section>
</3000000020481>
<3000000020509>
<tabularSections>
<section name="Education">
</section> <section name="Dependent">
</section> </tabularSections>
<section name="Work">
<field name="Reporting_To.ID">
3000000020481</field>
<field name="Extension"></field> <field name="Work_location">
</field>
<field name="Role.ID">
3000000015533</field>
<field name="Work_phone">
</field>
<field name="Role">
Team member</field>
<field name="Department">
People</field>
<field name="Employeestatus">
Active</field>
<field name="Reporting_To">charless charless 12</field>
<field name="Department.ID">3000000032001</field>
</section>
<section name="Basic Info">
<field name="Nick_Name">
</field>
<field name="EmployeeID">
2</field>
<field name="Decision_box_1">true</field>
<field name="FirstName">
charless</field> <field name="LastName">
charless.sp+sham_tst</field> <field name="EmailID">
charless@zohocorp.com</field>
</section>
<section name="Summary">
<field name="Current_Job_Description">
</field>
<field name="Expertise">
</field>
<field name="AboutMe">
</field>
</section> <section name="Personal">
<field name="Tags">
</field>
<field name="Date_of_birth">
11-Sep-1987</field> <field name="Address">
</field>
<field name="Other_Email">
</field>
<field name="Mobile"></field> </section>
</3000000020509> </result>
</response>

Show full

Show less