Get Variable Group Data

Purpose

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

Request URL

https://www.zohoapis.com/crm/v2/settings/variable_groups/{variable_group_id}

variable_id - The unique ID of the variable

Request Method

GET

Scope

scope=ZohoCRM.settings.variable_groups.{operation_type}

 
Possible operation types
ALL - Full access to variable data
READ - Get variable data

Sample Request: Using Variable Group ID

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

Sample Response: For Variable Group ID

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"
        }
    ]
}

Sample Request: Using Variable Group API Name

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

Sample Response: For Variable Group API Name

Copied{
    "variable_groups": [
       {
            "display_label": "Group3",
            "api_name": "Group3",
            "name": "Group3",
            "description": "This describes variable 3",
            "id": "40000000042001"
        }
    ]
}