Related Lists Meta Data

Purpose

To get the related list data of a particular module.

Request Details

Request URL

{api-domain}/crm/v2/settings/related_lists?module={module_api_name}

Supported modules

Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, and Custom

Header

Authorization: Zoho-oauthtoken 100xx.d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.related_lists.READ
(or)
scope=ZohoCRM.settings.related_lists.ALL
(or)
scope=ZohoCRM.settings.ALL

Parameters

  • modulestring, mandatory

    Specify the API name of the required module. For example, Leads, Contacts, Accounts, Deals, and so on.

Note
  • The "href" attribute in the response must be used in the URL to call the related list API. For example, the URL for calling the related list API must be: https://{{your-domain}}.zohoplatform.com/crm/v2/Leads/{ENTITYID}/Notes.

Sample Request

Copiedcurl "https://zylkercorp.zohoplatform.com/crm/v2/settings/related_lists?module=Leads"
-X GET
-H "Authorization: Zoho-oauthtoken 100xx.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
1.0.0ES6
Copied//Get instance of RelatedListsOperations Class that takes moduleAPIName as parameter
let relatedListsOperations = new ZCRM.RelatedList.Operations(moduleAPIName);
//Call getRelatedLists method
let response = await relatedListsOperations.getRelatedLists();
Copiedvar listener = 0;
class RelatedListsMetaData {

	async getRelatedLists()	{
		var url = "https://zylkercorp.zohoplatform.com/crm/v2/settings/related_lists"
        var parameters = new Map()
        var headers = new Map()
        var token = {
            clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
            redirectUrl:"http://127.0.0.1:5500/redirect.html",
            scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
        }
        var accesstoken = await new RelatedListsMetaData().getToken(token)
        headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
        parameters.set("module", "Leads")
        var requestMethod = "GET"
        var reqBody = null
        var params = "";
        parameters.forEach(function(value, key) {
            if (parameters.has(key)) {
                if (params) {
                    params = params + key + '=' + value + '&';
                }
                else {
                    params = key + '=' + value + '&';
                }
            }
        });
        var apiHeaders = {};
        if(headers) {
            headers.forEach(function(value, key) {
                apiHeaders[key] = value;
            });
        }
        if (params.length > 0){
            url = url + '?' + params.substring(0, params.length - 1);
        }
        var requestObj = {
            uri : url,
            method : requestMethod,
            headers : apiHeaders,
            body : JSON.stringify(reqBody),
            encoding: "utf8",
            allowGetBody : true,
			throwHttpErrors : false
        };
        var result = await new RelatedListsMetaData().makeAPICall(requestObj);
        console.log(result.status)
        console.log(result.response)
    }

	async getRelatedList()	{
		var url = "https://zylkercorp.zohoplatform.com/crm/v2/settings/related_lists/347706115122"
        var parameters = new Map()
        var headers = new Map()
        var token = {
            clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
            redirectUrl:"http://127.0.0.1:5500/redirect.html",
            scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
        }
        var accesstoken = await new RelatedListsMetaData().getToken(token)
        headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
        parameters.set("module", "Leads")
        var requestMethod = "GET"
        var reqBody = null
        var params = "";
        parameters.forEach(function(value, key) {
            if (parameters.has(key)) {
                if (params) {
                    params = params + key + '=' + value + '&';
                }
                else {
                    params = key + '=' + value + '&';
                }
            }
        });
        var apiHeaders = {};
        if(headers) {
            headers.forEach(function(value, key) {
                apiHeaders[key] = value;
            });
        }
        if (params.length > 0){
            url = url + '?' + params.substring(0, params.length - 1);
        }
        var requestObj = {
            uri : url,
            method : requestMethod,
            headers : apiHeaders,
            body : JSON.stringify(reqBody),
            encoding: "utf8",
            allowGetBody : true,
			throwHttpErrors : false
        };
        var result = await new RelatedListsMetaData().makeAPICall(requestObj);
        console.log(result.status)
        console.log(result.response)
	}

    async getToken(token) {

        if(listener == 0) {

            window.addEventListener("storage", function(reponse) {
                if(reponse.key === "access_token" && (reponse.oldValue != reponse.newValue || reponse.oldValue == null)){
                    location.reload();
                }
                if(reponse.key === "access_token"){

                    sessionStorage.removeItem("__auth_process");
                }
            }, false);
            listener = 1;
            if(sessionStorage.getItem("__auth_process")) {
                sessionStorage.removeItem("__auth_process");
            }
        }
        ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
            var isKeyExists = localStorage.hasOwnProperty(k);
            if(isKeyExists) {
                sessionStorage.setItem(k, localStorage[k]);
            }
            localStorage.removeItem(k);
        });
        var valueInStore = sessionStorage.getItem("access_token");
        var tokenInit = sessionStorage.getItem("__token_init");
        if(tokenInit != null && valueInStore != null && Date.now() >= parseInt(tokenInit) + 59 * 60 * 1000){ // check after 59th minute
            valueInStore = null;
            sessionStorage.removeItem("access_token");
        }

        var auth_process = sessionStorage.getItem("__auth_process");
        if ((valueInStore == null && auth_process == null) || (valueInStore == 'undefined' && (auth_process == null || auth_process == "true"))) {
            var accountsUrl = "https://zylkercorp.zohoplatform.com/oauth/v2/auth"
            var clientId;
            var scope;
            var redirectUrl;
            if(token != null) {
                clientId = token.clientId;
                scope = token.scope;
                redirectUrl = token.redirectUrl;
            }

            var fullGrant = sessionStorage.getItem("full_grant");
            var grantedForSession = sessionStorage.getItem("granted_for_session");
            if(sessionStorage.getItem("__token_init") != null && ((fullGrant != null && "true" == full_grant) || (grantedForSession != null && "true" == grantedForSession))) {
                accountsUrl += '/refresh';
            }
            if (clientId && scope) {
                sessionStorage.setItem("__token_init", Date.now());
                sessionStorage.removeItem("access_token");
                sessionStorage.setItem("__auth_process", "true");
                window.open(accountsUrl + "?" + "scope" + "=" + scope + "&"+ "client_id" +"=" + clientId + "&response_type=token&state=zohocrmclient&redirect_uri=" + redirectUrl);
                ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
                    var isKeyExists = localStorage.hasOwnProperty(k);
                    if(isKeyExists){
                        sessionStorage.setItem(k, localStorage[k]);
                    }
                    localStorage.removeItem(k);
                });
                valueInStore = sessionStorage.getItem("access_token");
            }
        }
        if(token != null && valueInStore != 'undefined'){
            token.accessToken = valueInStore;
        }
        return token.accessToken;
    }

    async makeAPICall(requestDetails) {
        return new Promise(function (resolve, reject) {
            var body, xhr, i;
            body = requestDetails.body || null;
            xhr = new XMLHttpRequest();
            xhr.withCredentials = true;
            xhr.open(requestDetails.method, requestDetails.uri, true);
            for (i in requestDetails.headers) {
                xhr.setRequestHeader(i, requestDetails.headers[i]);
            }
            xhr.send(body);
            xhr.onreadystatechange = function() {
                if(xhr.readyState == 4) {
                    resolve(xhr);
                }
            }
        })
    }
}
Copiedresponse = invokeurl
[
	url: "https://zylkercorp.zohoplatform.com/crm/v2/settings/related_lists?module=Leads"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

Response JSON Keys

  • sequence_numberinteger

    Represents the position of the related list in the module, in your organization.

  • display_labelstring

    Represents the display name of the related list.

  • api_namestring

    Represents the API name of the related list.

  • modulestring

    Represents the API name of the module to which the related list belongs to.

  • namestring

    Represents the display name of the module to which the related list belongs to.

  • idstring

    Represents the unique ID of the related list.

  • hrefstring

    Represents the URL reference to access the current related list.

  • typestring

    Represents the type of the current related list. The value can be either default or multiselectlookup.

  • connectedmodulestring

    If the related list is a multi-select lookup, the key represents the API name of the related module.

  • linkingmodulestring

    Represents the API name of the linking module.

Possible Errors

  • REQUIRED_PARAM_MISSINGHTTP 400

    Bad Request
    Resolution: You have not specified the mandatory parameter. Refer to parameters section above.

  • INVALID_MODULEHTTP 400

    The module name given seems to be invalid
    Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.

  • INVALID_MODULEHTTP 400

    The given module is not supported in API
    Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoCRM.settings.related_lists.READ scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to read
    Resolution: The user does not have permission to read related lists data. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to read related lists data
    Resolution: The user does not have the permission to retrieve related lists data. Contact your system administrator.

Sample Response

Copied{
    "related_lists": [
        {
            "sequence_number": "1",
            "display_label": "Notes",
            "api_name": "Notes",
            "module": "Notes",
            "name": "Notes",
            "action": null,
            "id": "3652397000000015122",
            "href": "Leads/{ENTITYID}/Notes",
            "type": "default"
        },
        {
            "sequence_number": "2",
            "display_label": "Attachments",
            "api_name": "Attachments",
            "module": "Attachments",
            "name": "Attachments",
            "action": null,
            "id": "3652397000000003771",
            "href": "Leads/{ENTITYID}/Attachments",
            "type": "default"
        },
        {
            "sequence_number": "3",
            "display_label": "Products",
            "api_name": "Products",
            "module": "Products",
            "name": "Products",
            "action": null,
            "id": "3652397000000003773",
            "href": "Leads/{ENTITYID}/Products",
            "type": "default"
        },
        {
            "sequence_number": "4",
            "display_label": "Open Activities",
            "api_name": "Activities",
            "module": "Activities",
            "name": "Activities",
            "action": null,
            "id": "3652397000000003769",
            "href": "Leads/{ENTITYID}/Activities",
            "type": "default"
        },
        {
            "sequence_number": "5",
            "display_label": "Closed Activities",
            "api_name": "Activities_History",
            "module": "Activities",
            "name": "Activities History",
            "action": null,
            "id": "3652397000000003767",
            "href": "Leads/{ENTITYID}/Activities_History",
            "type": "default"
        },
        {
            "sequence_number": "6",
            "display_label": "Invited Events",
            "api_name": "Invited_Events",
            "module": "Events",
            "name": "Invited Events",
            "action": null,
            "id": "3652397000000062001",
            "href": "Leads/{ENTITYID}/Invited_Events",
            "type": "default"
        },
        {
            "sequence_number": "6",
            "display_label": "Emails",
            "api_name": "Emails",
            "module": "Emails",
            "name": "Emails",
            "action": null,
            "id": "3652397000000014410",
            "href": null,
            "type": "default"
        },
        {
            "sequence_number": "7",
            "display_label": "Zoho Desk",
            "api_name": "Zoho_Support",
            "module": null,
            "name": "Zoho Support",
            "action": null,
            "id": "3652397000000209001",
            "href": null,
            "type": "default"
        },
        {
            "sequence_number": "8",
            "display_label": "Campaigns",
            "api_name": "Campaigns",
            "module": "Campaigns",
            "name": "Campaigns",
            "action": null,
            "id": "3652397000000040017",
            "href": "Leads/{ENTITYID}/Campaigns",
            "type": "default"
        },
        {
            "sequence_number": "9",
            "display_label": "Social",
            "api_name": "Social",
            "module": "Social",
            "name": "Social",
            "action": null,
            "id": "3652397000000065003",
            "href": null,
            "type": "default"
        },
        {
            "sequence_number": "10",
            "display_label": "Checklists",
            "api_name": "CheckLists",
            "module": "CheckLists",
            "name": "CheckLists",
            "action": null,
            "id": "3652397000000141005",
            "href": "Leads/{ENTITYID}/CheckLists",
            "type": "default"
        },
        {
            "sequence_number": "11",
            "display_label": "Zoho Survey",
            "api_name": "Zoho_Survey",
            "module": null,
            "name": "Zoho Survey",
            "action": null,
            "id": "3652397000000209037",
            "href": null,
            "type": "default"
        },
        {
            "sequence_number": "12",
            "display_label": "Zoho - {1} SalesIQ",
            "api_name": "Visits_Zoho_Livedesk",
            "module": "Visits",
            "name": "Visits - Zoho Livedesk",
            "action": null,
            "id": "3652397000000213048",
            "href": "Leads/{ENTITYID}/Visits_Zoho_Livedesk",
            "type": "default"
        },
        {
            "sequence_number": "13",
            "display_label": "Related List Name 1",
            "api_name": "Related_List_Name_1",
            "module": "Accounts",
            "name": "Related List Name 1",
            "action": null,
            "id": "3652397000000381023",
            "href": "Leads/{ENTITYID}/Related_List_Name_1",
            "type": "custom_lookup"
        }
    ]
}