Developer API Help

getRelatedRecords Method

Purpose

You can use the getRelatedRecords method to fetch related records.

For example: You can fetch Leads related to a Campaign or fetch tasks related to an Account.

Request URL

XML Format:
https://crm.zoho.com/crm/private/xml/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&parentModule=Module Name

JSON Format:
https://crm.zoho.com/crm/private/json/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&parentModule=Module Name

Request Parameters

Parameter Data Type Description
authtoken* String Encrypted alphanumeric string to authenticate your Zoho credentials. 
scope* String Specify the value as crmapi
parentModule* String Module for which you want to fetch the related records
Example: If you want to fetch Leads related to a Campaign, then Campaigns is your parent module.
id* Integer The id of the record for which you want to fetch related records
newFormat Integer newFormat=1: To exclude fields with "null" values while inserting data from your CRM account.
newFormat=2:To include fields with "null" values while inserting data from your CRM account.
fromIndex Integer Default value - 1
toIndex Integer Default value - 20
Maximum value - 200

* - Mandatory parameter

Note:

  • The getRelatedRecords method does not support Custom Lookup fields.

Related Lists Supported

The getRelatedRecords method supports all modules and their respective Related Lists except Emails, Competitors and Integrations (Zoho Support, Zoho Projects, etc)

Examples

To fetch Leads related to a Campaign ( with id 121212121 )

URL Format:

https://crm.zoho.com/crm/private/json/Leads/getRelatedRecords?newFormat=1&authtoken=sbdjEDBDJ1323&scope=crmapi&parentModule=Campaigns&id=121212121

To fetch the Stage History related to a Potential

URL Format:

https://crm.zoho.com/crm/private/xml/PotStageHistory/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=468939000000054013&parentModule=Potentials

To fetch Contact Roles related to a Potential

URL Format:

https://crm.zoho.com/crm/private/xml/ContactRoles/getRelatedRecords?authtoken=Auth Token&scope=crmapi
&id=468939000000054013&parentModule=Potentials

To view files attached to a record

URL Format:

https://crm.zoho.com/crm/private/xml/Attachments/getRelatedRecords?authtoken=Your Auth Token&newFormat=1&scope=crmapi&parentModule=Leads&id=508020000000957321

Sample Response

<response uri="/crm/private/xml/Attachments/getRelatedRecords">
<result>
<Attachments>
<row no="1">
<FL val="id">5080200000005483628</FL>
<FL val="File Name">
<![CDATA[ wallpaper.jpeg ]]>
</FL>
<FL val="Size">
<![CDATA[ 175662 bytes ]]>
</FL>
<FL val="Modified Time">
<![CDATA[ 2012-07-03 14:58:36 ]]>
</FL>
<FL val="SMOWNERID">508020000000065849</FL>
<FL val="Attached By">
<![CDATA[ charles stone]]>
</FL>
</row>
<row no="2">
<FL val="id">5080200000000906253</FL>
<FL val="File Name">
<![CDATA[ image.jpeg ]]>
</FL>
<FL val="Size">
<![CDATA[ 8550 bytes ]]>
</FL>
<FL val="Modified Time">
<![CDATA[ 2012-07-03 14:58:35 ]]>
</FL>
<FL val="SMOWNERID">508020000000065849</FL>
<FL val="Attached By">
<![CDATA[ charles stone]]>
</FL>
</row>
<row no="3">
<FL val="id">5080200000009873561</FL>
<FL val="File Name">
<![CDATA[ sample-image.jpg ]]>
</FL>
<FL val="Size">
<![CDATA[ 114775 bytes ]]>
</FL>
<FL val="Modified Time">
<![CDATA[ 2012-07-03 14:58:35 ]]>
</FL>
<FL val="SMOWNERID">508020000000065849</FL>
<FL val="Attached By">
<![CDATA[ charles stone]]>
</FL>
</row>
<row no="4">
<FL val="id">5080200000001928374</FL>
<FL val="File Name">
<![CDATA[ test-img.jpg ]]>
</FL>
<FL val="Size">
<![CDATA[ 8161 bytes ]]>
</FL>
<FL val="Modified Time">
<![CDATA[ 2012-07-03 14:58:35 ]]>
</FL>
<FL val="SMOWNERID">508020000000065849</FL>
<FL val="Attached By">
<![CDATA[ charles stone]]>
</FL>
</row>
</Attachments>
</result>
</response>

To fetch notes under a record

URL Format:

https://crm.zoho.com/crm/private/xml/Notes/getRelatedRecords?authtoken=<Your Authtoken>&scope=crmapi&id=RECORD_ID&parentModule=Module Name

Sample Response

<response uri="/crm/private/xml/Notes/getRelatedRecords">
<result>
<Notes>
<row no="1">
<FL val="id">5080200000005483628</FL>
<FL val="Note Content">
<![CDATA[ New note under the record ]]>
</FL>
<FL val="SMOWNERID">508020000000065849</FL>
<FL val="Owner Name">
<![CDATA[ James ]]>
</FL>
<FL val="SMCREATORID">508020000000065849</FL>
<FL val="Created By">
<![CDATA[ James ]]>
</FL>
<FL val="Created Time">
<![CDATA[ 2012-12-12 05:00:00 ]]>
</FL>
<FL val="MODIFIEDBY">508020000000065849</FL>
<FL val="Modified By">
<![CDATA[ James ]]>
</FL>
<FL val="Modified Time">
<![CDATA[ 2012-12-12 05:00:00 ]]>
</FL>
<FL val="ISVOICENOTES">
<![CDATA[ false ]]>
</FL>

</row>
</Notes>
</result>
</response>

Top