Layouts Meta Data

Purpose

To get details of the layouts associated with a particular module.

Request Details

Request URL

{api-domain}/crm/v2/settings/layouts?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, Custom, and Activities

Header

Authorization: Zoho-oauthtoken 100xx.d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.layouts.READ
(or)
scope=ZohoCRM.settings.layouts.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.

Sample Request

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

	async getLayouts()	{
		var url = "https://zylkercorp.zohoplatform.com/crm/v2/settings/layouts"
        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 LayoutsMetaData().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 LayoutsMetaData().makeAPICall(requestObj);
        console.log(result.status)
        console.log(result.response)
    }

	async getLayout()	{
		var url = "https://zylkercorp.zohoplatform.com/crm/v2/settings/layouts/347706191055"
        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 LayoutsMetaData().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 LayoutsMetaData().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/layouts?module=Leads"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

Response JSON Keys

  • created_timestring

    Represents the date and time at which the current layout was created.

  • convert_mappingJSON object

    Represents the base layout details.

  • modified_timestring

    Represents the date and time at which the layout was last modified.

  • visibleboolean

    Represents if the current layout is visible to the user.
    true: The current layout is visible to the user.
    false: The current layout is not visible to the user.

  • namestring

    Represents the name of the layout.

  • modified_byJSON object

    Represents the name and ID of the user who last modified the layout.

  • profilesJSON array

    Each object in the array represents the name and ID of the profile that has access to the current layout.

  • idstring

    Represents the unique ID of the layout.

  • created_byJSON object

    Represents the name and ID of the user who created the layout.

  • sectionsJSON array

    Each object in the array represents the details of sections in the current layout. The following section represents the keys in this JSON array.

Keys in 'sections' JSON array

  • display_labelstring

    Represents the display name of the section.

  • sequence_numberinteger

    Represents the position of the section in the layout.

  • isSubformSectionboolean

    Represents if the section is the subform section.
    true: The current section is a subform section.
    false: The current section is not a subform section.

  • api_namestring

    Represents the API name of the section.

  • namestring

    Represents the display name of the current section.

  • generated_typestring

    Represents if the section is a default or a custom section.

  • fieldsJSON array

    Each object in the array represents the details of a field in the section. Refer to fields metadata API to know more about the keys in this array.

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.layouts.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 layouts 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 layouts data
    Resolution: The user does not have the permission to retrieve layouts data. Contact your system administrator.

Sample Response

Copied{
  "layouts": [
    {
      "created_time": null,
      "convert_mapping": {
        "Contacts": {
          "name": "Standard",
          "id": "4150868000000091033"
        },
        "Deals": {
          "name": "Standard",
          "id": "4150868000000091023",
          "fields": [
            {
              "api_name": "Amount",
              "field_label": "Amount",
              "id": "4150868000000002557",
              "required": false
            },
            {
              "api_name": "Deal_Name",
              "field_label": "Potential Name",
              "id": "4150868000000002559",
              "required": true
            },
            {
              "api_name": "Closing_Date",
              "field_label": "Closing Date",
              "id": "4150868000000002561",
              "required": false
            },
            {
              "api_name": "Stage",
              "field_label": "Stage",
              "id": "4150868000000002565",
              "required": true
            },
            {
              "api_name": "Next_Step",
              "field_label": "Next Step",
              "id": "4150868000000002571",
              "required": false
            },
            {
              "api_name": "Currency",
              "field_label": "Currency",
              "id": "4150868000000050013",
              "required": false
            }
          ]
        },
        "Accounts": {
          "name": "Standard",
          "id": "4150868000000091029"
        }
      },
      "modified_time": "2020-07-27T18:35:17+05:30",
      "visible": true,
      "created_for": null,
      "name": "Standard",
      "modified_by": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013"
      },
      "profiles": [
        {
          "default": true,
          "name": "Administrator",
          "id": "4150868000000026011"
        },
        {
          "default": true,
          "name": "Standard",
          "id": "4150868000000026014"
        }
      ],
      "id": "4150868000000091055",
      "created_by": null,
      "sections": [
        {
          "display_label": "Lead Image",
          "sequence_number": 1,
          "isSubformSection": false,
          "tab_traversal": 2,
          "api_name": "Lead Image",
          "column_count": 1,
          "name": "Record Image",
          "generated_type": "default",
          "fields": [
            {
              "system_mandatory": false,
              "private": null,
              "webhook": false,
              "json_type": "string",
              "crypt": null,
              "field_label": "Lead Image",
              "tooltip": null,
              "created_source": "default",
              "field_read_only": false,
              "required": false,
              "display_label": "Record Image",
              "validation_rule": null,
              "section_id": 5,
              "read_only": false,
              "association_details": null,
              "multi_module_lookup": {},
              "currency": {},
              "id": "4150868000000152001",
              "custom_field": false,
              "lookup": {},
              "convert_mapping": {
                "Contacts": null,
                "Deals": null,
                "Accounts": null
              },
              "visible": true,
              "length": 255,
              "view_type": {
                "view": true,
                "edit": true,
                "quick_create": false,
                "create": true
              },
              "default_value": null,
              "subform": null,
              "sequence_number": 1,
              "api_name": "Record_Image",
              "unique": {},
              "data_type": "profileimage",
              "formula": {},
              "decimal_place": null,
              "multiselectlookup": {},
              "pick_list_values": [],
              "auto_number": {}
            },
            {
              "system_mandatory": false,
              "private": {
                "restricted": true,
                "type": "High",
                "export": true
              },
              "webhook": true,
              "json_type": "string",
              "crypt": null,
              "field_label": "HIPAA",
              "tooltip": null,
              "created_source": "default",
              "field_read_only": false,
              "display_label": "HIPAA",
              "ui_type": 1,
              "read_only": false,
              "association_details": null,
              "businesscard_supported": false,
              "currency": {},
              "id": "4150868000005292001",
              "custom_field": true,
              "lookup": {},
              "hipaa_compliance": {
                "restricted_in_export": true,
                "restricted": false
              },
              "convert_mapping": {
                "Contacts": null,
                "Deals": null,
                "Accounts": null
              },
              "visible": true,
              "length": 255,
              "view_type": {
                "view": true,
                "edit": true,
                "quick_create": false,
                "create": true
              },
              "subform": null,
              "external": null,
              "api_name": "HIPAA",
              "unique": {},
              "history_tracking": false,
              "data_type": "text",
              "formula": {},
              "hipaa_compliance_enabled": true,
              "decimal_place": null,
              "mass_update": true,
              "multiselectlookup": {},
              "pick_list_values": [],
              "auto_number": {}
            }
          ],
          "properties": null
        }
      ],
      "status": 0
    }
  ]
}