Specific Variable Data

Purpose

To get the details of any specific variable. 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/variables/{variable_id}?group={variable_group_id}

variable_id - The unique ID of the variable.

variable_group_id - The unique ID of the variable group.

Request Method

GET

Scope

scope=ZohoCRM.settings.variables.{operation_type}

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

Parameters

Parameter NameData TypeDescription
group*Integer/StringSpecify the unique ID/API name of the group to which the variable belongs.
 
Note:

Group ID/group API name is mandatory in case of fetching specific variable data. The system throws an error, otherwise.

Sample Request: Using Variable ID and Group ID

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

Sample Response: For Variable ID and Group ID

Copied{
    "variables": [
       {
            "api_name": "Variable1",
            "name": "Variable1",
            "description": "This denotes variable 1 description",
            "id": "40000000047003",
            "type": "text",
            "variable_group": {
                "api_name": "Group1",
                "id": "40000000047001"
            },
            "value": "This denotes variable one value"
        }
    ]
}

Sample Request: Using Variable API Name and Group ID

Copiedcurl "https://www.zohoapis.com/crm/v2/settings/variables/VariableSix?group=40000000047001"
-X GET
-H "Authorization: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52"

Sample Response: For Variable API Name and Group ID

Copied{
    "variables": [
       {
            "api_name": "VariableSix",
            "name": "Variable6",
            "description": "On the sea shore",
            "id": "40000000044005",
            "type": "text",
            "variable_group": {
                "api_name": "MyCustsdomGroup",
                "id": "40000000044003"
            },
            "value": "She sells sea shells"
        }
    ]
}

Sample Request: Using Variable ID and Group API Name

Copiedcurl "https://www.zohoapis.com/crm/v2/settings/variables/40000000047003?group=Group2"
-X GET
-H "Authorization: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52"

Sample Response: For Variable ID and Group API Name

Copied{
    "variables": [
       {
            "api_name": "Variable2",
            "name": "Variable2",
            "description": "This denotes variable 2 description",
            "id": "40000000047007",
            "type": "integer",
            "variable_group": {
                "api_name": "Group2",
                "id": "40000000047005"
            },
            "value": "2"
        }
    ]
}