Get Variable Groups

Purpose

To get the details of variable groups. Specify the unique ID or the API name of the variable group in your API request to get the data for that particular variable group.

Endpoints

GET /settings/variable_groups

GET /settings/variable_groups/{variable_group_id (or) variable_group_API_name}

Request Details

Request URL

{api-domain}/crm/{version}/settings/variable_groups
To fetch a specific variable group:
{api-domain}/crm/{version}/settings/variable_groups/{variable_group_id (or) variable_group_API_name}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.variable_groups.{operation_type}

Possible operation types

ALL - Full access to variable data
READ - Get variable group data

Sample Request

Curl Java PHP Csharp Python Node JS Ruby Deluge

Copiedcurl "https://www.zohoapis.com/crm/v2.1/settings/variable_groups"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

3.0.08.0

Copied//Get instance of VariableGroupsOperations Class
VariableGroupsOperations variableGroupsOperations = new VariableGroupsOperations();

//Call getVariableGroups method 
APIResponse < ResponseHandler > response = variableGroupsOperations.getVariableGroups();

Copiedpackage com.zoho.crm.api.sample.restapi.variables;
import javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
public class GetVariableGroups 
{
	private static void getVariableGroups()
	{
		try
		{
			HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
			SSLContext sslContext = SSLContext.getDefault();
			SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
			CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
			URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2.1/settings/variable_groups");
			HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
			requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
			HttpResponse response = httpclient.execute(requestObj);
			HttpEntity responseEntity = response.getEntity();
			System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
			if(responseEntity != null)
			{
				Object responseObject = EntityUtils.toString(responseEntity);
				String responseString = responseObject.toString();
				System.out.println(responseString);
			}
		}
		catch(Exception ex)
		{
			ex.printStackTrace();
		}
	}
	private static void getVariableGroup()
	{
		try
		{
			HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
			SSLContext sslContext = SSLContext.getDefault();
			SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
			CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
			URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2.1/settings/variable_groups/General");
			HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
			requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
			HttpResponse response = httpclient.execute(requestObj);
			HttpEntity responseEntity = response.getEntity();
			System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
			if(responseEntity != null)
			{
				Object responseObject = EntityUtils.toString(responseEntity);
				String responseString = responseObject.toString();
				System.out.println(responseString);
			}
		}
		catch(Exception ex)
		{
			ex.printStackTrace();
		}
	}
	public static void main(String[] args) 
	{
		getVariableGroups();
		getVariableGroup();
	}
}

4.0.04.x

Copied//Get instance of VariableGroupsOperations Class
$variableGroupsOperations = new VariableGroupsOperations();
//Call getVariableGroups method
$response = $variableGroupsOperations->getVariableGroups();

Copied<?php
class GetVariableGroups{

    public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $curl_options[CURLOPT_URL] = "https://www.zohoapis.com/crm/v2.1/settings/variable_groups";
        $curl_options[CURLOPT_RETURNTRANSFER] = true; 
        $curl_options[CURLOPT_HEADER] = 1;
        $curl_options[CURLOPT_CUSTOMREQUEST] = "GET";
        $headersArray = array();

        $headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " . "1000.30f3a589XXXXXXXXXXXXXXXXXXX4077.dc5XXXXXXXXXXXXXXXXXXXee9e7c171c";
        
        $curl_options[CURLOPT_HTTPHEADER]=$headersArray;
        
        curl_setopt_array($curl_pointer, $curl_options);

        $result = curl_exec($curl_pointer);
        $responseInfo = curl_getinfo($curl_pointer);
        curl_close($curl_pointer);
        list ($headers, $content) = explode("\r\n\r\n", $result, 2);
        if(strpos($headers," 100 Continue")!==false){
            list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
        }
        $headerArray = (explode("\r\n", $headers, 50));
        $headerMap = array();
        foreach ($headerArray as $key) {
            if (strpos($key, ":") != false) {
                $firstHalf = substr($key, 0, strpos($key, ":"));
                $secondHalf = substr($key, strpos($key, ":") + 1);
                $headerMap[$firstHalf] = trim($secondHalf);
            }
        }
        $jsonResponse = json_decode($content, true);
        if ($jsonResponse == null && $responseInfo['http_code'] != 204) {
            list ($headers, $content) = explode("\r\n\r\n", $content, 2);
            $jsonResponse = json_decode($content, true);
        }
        var_dump($headerMap);
        var_dump($jsonResponse);
        var_dump($responseInfo['http_code']);
       
    }
    
}
(new GetVariableGroups())->execute();

3.0.08.x

Copied//Get instance of VariableGroupsOperations Class
VariableGroupsOperations variableGroupsOperations = new VariableGroupsOperations();
//Call GetVariableGroups method 
APIResponse<ResponseHandler> response = variableGroupsOperations.GetVariableGroups();

Copiedusing System;
using System.IO;
using System.Net;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Variables
{
    public class VariableGroups
    {
        public static void GetVariableGroups()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/settings/variable_groups");
            request.Method = "GET";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            request.KeepAlive = true;
            HttpWebResponse response;
            try
            {
                response = (HttpWebResponse)request.GetResponse();
            }
            catch (WebException e)
            {
                if (e.Response == null) { throw; }
                response = (HttpWebResponse)e.Response;
            }
            HttpWebResponse responseEntity = response;
            Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
            string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
            responseEntity.Close();
            Console.WriteLine(responsestring);
        }
        public static void GetVariableGroup()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/settings/variable_groups/General");
            request.Method = "GET";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            request.KeepAlive = true;
            HttpWebResponse response;
            try
            {
                response = (HttpWebResponse)request.GetResponse();
            }
            catch (WebException e)
            {
                if (e.Response == null) { throw; }
                response = (HttpWebResponse)e.Response;
            }
            HttpWebResponse responseEntity = response;
            Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
            string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
            responseEntity.Close();
            Console.WriteLine(responsestring);
        }
    }
}

3.0.03.x.x

Copied# Get instance of VariableGroupsOperations Class
variable_groups_operations = VariableGroupsOperations()
# Call get_variable_groups method
response = variable_groups_operations.get_variable_groups()

Copieddef get_variable_groups():
    import requests

    url = 'https://www.zohoapis.com/crm/v2.1/settings/variable_groups'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
    }

    response = requests.get(url=url, headers=headers)

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())

get_variable_groups()


def get_variable_group():
    import requests

    url = 'https://www.zohoapis.com/crm/v2.1/settings/variable_groups/General'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
    }

    response = requests.get(url=url, headers=headers)

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())

get_variable_group()

1.0.010.x

Copied//Get instance of VariableGroupsOperations Class
let variableGroupsOperations = new VariableGroupsOperations();
//Call getVariableGroups method
let response = await variableGroupsOperations.getVariableGroups();

Copiedasync function getVariableGroups() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2.1/settings/variable_groups'

    let headers = {
        Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
    }

    let requestDetails = {
        method : "GET",
        headers : headers,
        throwHttpErrors : false
    }
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    } 
}
getVariableGroups()

async function getVariableGroup() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2.1/settings/variable_groups/General'

    let headers = {
        Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
    }

    let requestDetails = {
        method : "GET",
        headers : headers,
        throwHttpErrors : false
    }
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    } 
}

getVariableGroup()

2.1.0

Copied# Get instance of VariableGroupsOperations Class
vgo = VariableGroups::VariableGroupsOperations.new
# Call get_variable_groups method
response = vgo.get_variable_groups

Copiedrequire 'net/http'
require 'json'

class GetVariablesGroups

    def execute

        url = "https://www.zohoapis.com/crm/v2.1/settings/variable_groups"
        url = URI(url)
        req = Net::HTTP::Get.new(url.request_uri)
        http = Net::HTTP.new(url.host, url.port)
        http.use_ssl = true
        headers={}
        headers["Authorization"]="Zoho-oauthtoken 1000.dfa7XXXXXXXXXXXXXXXXXX84f9665840.c176aeXXXXXXXXXXXX13f3d37a84d"
        headers&.each { |key, value| req.add_field(key, value) }
        response=http.request(req)
        status_code = response.code.to_i
        headers = response.each_header.to_h
        print status_code
        print headers
        unless response.body.nil?
            print  response.body
        end
    end
end
GetVariablesGroups.new.execute

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v2.1/settings/variable_groups/40000000047003"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

Response JSON keys

display_labelstring
Represents the display name of the CRM variable group.
api_namestring
Represents the API name of the CRM variable group.
namestring
Represents the name of the CRM variable group.
descriptionstring
Represents the description of the CRM variable group, if any.
idstring
Represents the unique ID of the CRM variable group.

Possible Errors

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.variable_groups.READ scope. Create a new client with valid scope. Refer to scope section above.
NO_PERMISSIONHTTP 403
Permission denied to read records
Resolution: The user does not have permission to read variable group 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 variable group data
Resolution: The user does not have the permission to read variable group data. Contact your system administrator.

Sample Response

Copied{
    "variable_groups": [
       {
            "display_label": "General",
            "api_name": "General",
            "name": "General",
            "description": null,
            "id": "40000000039001"
        },
       {
            "display_label": "Group1",
            "api_name": "Group1",
            "name": "Group1",
            "description": null,
            "id": "40000000047001"
        },
       {
            "display_label": "Group2",
            "api_name": "Group2",
            "name": "Group2",
            "description": null,
            "id": "40000000047005"
        },
       {
            "display_label": "Group3",
            "api_name": "Group3",
            "name": "Group3",
            "description": "This describes variable 3",
            "id": "40000000042001"
        },
       {
            "display_label": "Group4",
            "api_name": "Group4",
            "name": "Group4",
            "description": null,
            "id": "40000000042002"
        },
       {
            "display_label": "MyCustsdomGroup",
            "api_name": "MyCustsdomGroup",
            "name": "MyCustsdomGroup",
            "description": null,
            "id": "40000000044003"
        },
       {
            "display_label": "Variable6",
            "api_name": "VariableSix",
            "name": "Variable6",
            "description": "On the sea shore",
            "id": "40000000044001"
        }
    ]
}