Zoho: Get variable group by ID

← Variable groups operations · Get started

Operation zoho.getvariablegroupbyid

Provider route: GET /crm/v8/settings/variable_groups/{id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["variableGroups"]["getVariableGroupById"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.variableGroups.getVariableGroupById(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.variable_groups.get_variable_group_by_id(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Maximum length: 255

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Get variable group by ID — response body — variable groups
$ (anyOf 2)	null	Alternative

Referenced models: Get variable group by ID — response body — variable groups

Schemas

Get variable group by ID — response body — variable groups

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body for the get variable group by ID operation. Additional keys: not allowed
variable_groups	array	Required within parent	Represents an array containing the variable group matching the specified ID. Maximum items: 1
variable_groups[]	Model	Each item	Expand Variable Groups — variable Groups get Variable Groups — response body — variable groups item

Referenced models: Variable Groups — variable Groups get Variable Groups — response body — variable groups item

Variable Groups — variable Groups get Variable Groups — response body — variable groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a summary of a variable group returned in list and retrieval responses. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the variable group, used to reference the group in API calls. Maximum length: 100
description	JSON	Required within parent
description (anyOf 1)	string	Alternative	Represents the description of the variable group. This field is nullable. Maximum length: 3000
description (anyOf 2)	null	Alternative	Represents the description of the variable group. This field is nullable. Maximum length: 3000
display_label	string	Required within parent	Represents the display label of the variable group shown in the CRM interface. Maximum length: 100
id	string	Required within parent	Represents the unique ID of the variable group. Maximum length: 19
name	string	Required within parent	Represents the internal name of the variable group. Maximum length: 50
source	string	Required within parent	Represents the source of the variable group, indicating whether it is system-defined or user-defined. Maximum length: 255

Policy, approvals and errors

SDK function policy ID: zoho.getvariablegroupbyid. Catalog operation: getVariableGroupById. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source