getRelatedRecords Method - Comparison

getRelatedRecords Method - Comparison

Purpose

To retrieve records related to a primary module.

Request URL

Version 1.0:

https://crm.zoho.com/crm/private/xml/Contacts/getRelatedRecords?authtoken=AuthToken&scope=crmapi&id=Record ID&parentModule=Module Name

Version 2.0:

URL: https://www.zohoapis.com/crm/v2/Accounts/{record_id}/{relatedlist_api_name}

Method: GET

Header: Authorization=Zoho-oauthtoken {oauth_token}

Note:

  • The API names of the related lists can be found using this API(GET) - https://www.zohoapis.com/crm/v2/settings/related_lists?module=Accounts

Request Parameters

Version 1.0 Version 2.0
authtoken=**** Authorization=Zoho-oauthtoken ***** - as a Header.
scope=crmapi N/A
parentModule parent module api name has to be given in the request URL.
id id has to be given in the request URL.
fromIndex=1&toIndex=20 page=1&per_page=20
newFormat N/A

Sample Responses:

Response in Version 1.0 Response in Version 2.0
<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/crm/private/xml/Contacts/getRelatedRecords">
<result>
<Contacts>
<row no="1">
<FL val="CONTACTID">1386586000000803011</FL>
<FL val="SMOWNERID">1386586000000078001</FL>
<FL val="Contact Owner"><![CDATA[Bruce Wills]]></FL>
<FL val="Lead Source"><![CDATA[External Referral]]></FL>
<FL val="Last Name"><![CDATA[Marka]]></FL>
..
</row>
</Contacts>
</result>
</response>		 {
  "data": [
    {
      "Owner":{
       "name":"Bruce Wills",
       "id":"1386586000000078001"
      },
      "id":"1386586000000803011"
      ...
      "Last_Name":"Marka",
      "Lead_Source":"External Referral",
   }
  ],
  "info": {
      "per_page":200,
      "count":1,
      "page":1,
      "more_records": false
}}

    • Related Articles

    • getRelatedRecords Method

      Table of Contents Purpose Request URL Request Parameters Related Lists Supported Examples To fetch Leads related to a Campaign ( with id 121212121 ) To fetch the Stage History related to a Deal To fetch Contact Roles related to a Deal To view files ...

    • downloadPhoto Method - Comparison

      Purpose To download the photo of a lead or a contact. Request URL Version 1.0: https://crm.zoho.com/crm/private/xml/(Leads or Contacts)/downloadPhoto?authtoken=AuthToken&scope=crmapi&id=RecordID Version 2.0: URL: ...

    • downloadFile Method - Comparison

      Purpose To download a file attached to a record. Request URL Version 1.0: https://crm.zoho.com/crm/private/xml/Leads/downloadFile?authtoken=AuthToken&scope=crmapi&id=Attachment Id Version 2.0: URL: ...

    • deletePhoto Method - Comparison

      Purpose To delete a photo of a contact or lead. Request URL Version 1.0: https://crm.zoho.com/crm/private/xml/(Leads or Contacts)/deletePhoto?authtoken=AuthToken&scope=crmapi&id=RecordID Version 2.0: URL: https://www.zohoapis.com/crm/v2/{Leads or ...

    • deleteRecords Method - Comparison

      Purpose To delete the selected records. Request URL Version 1.0: https://crm.zoho.com/crm/private/xml/Leads/deleteRecords?authtoken=AuthToken&scope=crmapi&id=Record ID Version 2.0: URL: https://www.zohoapis.com/crm/v2/Leads/{record_id} Method: DELETE ...