Zoho: Get associations for a user group

← User groups operations · Get started

Operation zoho.getusergroupassociations

Provider route: GET /crm/v8/settings/user_groups/{group}/actions/associations. 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["userGroups"]["getUserGroupAssociations"]>[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.userGroups.getUserGroupAssociations(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.user_groups.get_user_group_associations(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.group	string	Required within parent	One of: 1234567890

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
$	object	Root	Response schema containing the list of CRM resources associated with the specified user group. Additional keys: not allowed
associations	array	Required within parent	Represents the array of CRM resources associated with the specified user group. Maximum items: 200
associations[]	object	Each item	Represents one CRM resource association for the user group, including the resource identifier, association type, and module details. Additional keys: not allowed
associations[].details	JSON	Required within parent
associations[].details (anyOf 1)	object	Alternative	Represents the CRM module details for this association. Additional keys: not allowed
associations[].details (anyOf 1).module	object	Required within parent	Represents the CRM module in which the associated resource is defined. Additional keys: not allowed
associations[].details (anyOf 1).module.api_name	string	Required within parent	Represents the API name of the module containing the associated resource. Maximum length: 255
associations[].details (anyOf 1).module.id	string	Required within parent	Represents the unique ID of the module containing the associated resource. Maximum length: 255
associations[].details (anyOf 2)	null	Alternative	Represents the CRM module details for this association. Additional keys: not allowed
associations[].details (anyOf 2).module	object	Required within parent	Represents the CRM module in which the associated resource is defined. Additional keys: not allowed
associations[].details (anyOf 2).module.api_name	string	Required within parent	Represents the API name of the module containing the associated resource. Maximum length: 255
associations[].details (anyOf 2).module.id	string	Required within parent	Represents the unique ID of the module containing the associated resource. Maximum length: 255
associations[].resource	object	Required within parent	Represents the CRM resource that is associated with the user group. Additional keys: not allowed
associations[].resource.id	string	Required within parent	Represents the unique ID of the associated resource (such as a sharing rule or workflow). Maximum length: 255
associations[].resource.name	string	Required within parent	Represents the name of the associated resource. Maximum length: 255
associations[].type	string	Required within parent	Represents the category of CRM resource associated with the user group, such as sharing rules, workflows, or automation rules. Maximum length: 255

Policy, approvals and errors

SDK function policy ID: zoho.getusergroupassociations. Catalog operation: getUserGroupAssociations. 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.

Official provider source