Zoho: Get associated groups for a user

← User groups operations · Get started

Operation zoho.getassociatedgroupsforuser

Provider route: GET /crm/v8/users/{user}/actions/associated_groups. 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"]["getAssociatedGroupsForUser"]>[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.getAssociatedGroupsForUser(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_associated_groups_for_user(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.user	string	Required within parent	One of: 3652397000000186017
query	object	Optional	Additional keys: not allowed
query.include	string	Optional	One of: sources_count, sources
query.page	integer	Optional	Default: 1 Format: int32 Minimum: 1
query.per_page	integer	Optional	Default: 200 Format: int32 Maximum: 200 Minimum: 1

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 paginated list of user groups associated with the specified user. Additional keys: not allowed
info	Model	Required within parent	Expand Get associated groups for a user — response body — info
user_groups	array	Required within parent	Represents the array of user groups associated with the specified user. Maximum items: 200
user_groups[]	object	Each item	Represents the details of a user group associated with the user, including metadata and optional sources and source counts. Additional keys: not allowed
user_groups[].created_by	object	Required within parent	Represents the user who created this user group. Additional keys: not allowed
user_groups[].created_by.id	string	Required within parent	Represents the unique ID of the user who created this group. Maximum length: 19
user_groups[].created_by.name	string	Required within parent	Represents the name of the user who created this group. Maximum length: 512
user_groups[].created_time	string	Required within parent	Represents the date and time of user group creation, in ISO 8601 format. Format: date-time
user_groups[].description	JSON	Required within parent	Represents the text description of the user group. Present in the response when a description was provided during group creation.
user_groups[].description (anyOf 1)	string	Alternative	Represents the text description of the user group. Maximum length: 250
user_groups[].description (anyOf 2)	null	Alternative	Indicates that no description was provided for the user group.
user_groups[].id	string	Required within parent	Represents the unique identifier of the user group. Maximum length: 19
user_groups[].modified_by	JSON	Required within parent	Represents the user who last modified this user group.
user_groups[].modified_by (anyOf 1)	object	Alternative	Represents the user who last modified this group, with their ID and name. Additional keys: not allowed
user_groups[].modified_by (anyOf 1).id	string	Required within parent	Represents the unique ID of the user who last modified this group. Maximum length: 19
user_groups[].modified_by (anyOf 1).name	string	Required within parent	Represents the name of the user who last modified this group. Maximum length: 512
user_groups[].modified_by (anyOf 2)	null	Alternative	Indicates that this group has not been modified since creation.
user_groups[].modified_time	JSON	Required within parent	Represents the date and time when the user group was last modified.
user_groups[].modified_time (anyOf 1)	string	Alternative	Represents the timestamp of the last modification in ISO 8601 format. Format: date-time
user_groups[].modified_time (anyOf 2)	null	Alternative	Indicates that the group has not been modified since creation.
user_groups[].name	string	Required within parent	Represents the name of the user group. Maximum length: 250
user_groups[].sources	array	Optional	Represents the array of member sources configured for this user group. Present when the include query parameter includes sources. Maximum items: 200
user_groups[].sources[]	object	Each item	Represents one member source entry for this user group. Additional keys: not allowed
user_groups[].sources[].source	object	Required within parent	Represents the identifier and name of the source. Additional keys: not allowed
user_groups[].sources[].source.id	string	Required within parent	Represents the unique ID of the source configured as a member. Maximum length: 19
user_groups[].sources[].source.name	string	Required within parent	Represents the name of the source configured as a member. Maximum length: 250
user_groups[].sources[].sub_territories	boolean	Optional	Indicates whether members from sub-territories are included for territory-type sources. Present when configured.
user_groups[].sources[].subordinates	boolean	Optional	Indicates whether users in subordinate roles are included for role-type sources. Present when configured.
user_groups[].sources[].type	string	Required within parent	Represents the type of this member source. Possible values: users - Individual CRM users. roles - CRM roles. territories - CRM territories. groups - CRM user groups. Known values: users, roles, territories, groups

Referenced models: Get associated groups for a user — response body — info

Schemas

Get associated groups for a user — response body — info

Field	Type	Presence	Description and constraints
$	object	Root	Represents pagination information for the response. Additional keys: not allowed
count	JSON	Required within parent
count (anyOf 1)	integer	Alternative	Represents the total number of user groups returned in the current response. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_records	boolean	Required within parent	Indicates whether additional user group records are available beyond the current page.
page	JSON	Required within parent
page (anyOf 1)	integer	Alternative	Represents the current page number in the paginated response. Format: int32
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_page	JSON	Required within parent
per_page (anyOf 1)	integer	Alternative	Represents the maximum number of user group records returned per page. Format: int32
per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

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