Zoho: Get sources for a user group

← User groups operations · Get started

Operation zoho.getusergroupsources

Provider route: GET /crm/v8/settings/user_groups/{group}/sources. 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"]["getUserGroupSources"]>[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.getUserGroupSources(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_sources(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
query	object	Optional	Additional keys: not allowed
query.filters	string	Optional	Maximum length: 250
query.include	string	Optional	One of: sources_count, sources
query.type	string	Optional	One of: users, roles, territories, groups
query.user_type	string	Optional	Maximum length: 100
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
$	JSON	Root
$ (anyOf 1)	object	Alternative	Response schema containing the paginated list of member sources for the user group. Additional keys: not allowed
$ (anyOf 1).info	object	Required within parent	Represents pagination information for the response. Additional keys: not allowed
$ (anyOf 1).info.count	JSON	Required within parent
$ (anyOf 1).info.count (anyOf 1)	integer	Alternative	Represents the total number of member sources returned in the current response. Format: int32
$ (anyOf 1).info.count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).info.more_records	boolean	Required within parent	Indicates whether additional member source records are available beyond the current page.
$ (anyOf 1).info.page	JSON	Required within parent
$ (anyOf 1).info.page (anyOf 1)	integer	Alternative	Represents the current page number in the paginated response. Format: int32
$ (anyOf 1).info.page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).info.per_page	JSON	Required within parent
$ (anyOf 1).info.per_page (anyOf 1)	integer	Alternative	Represents the maximum number of member source records returned per page. Format: int32
$ (anyOf 1).info.per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).sources	array	Required within parent	Represents the array of member sources configured for the user group. Maximum items: 200
$ (anyOf 1).sources[]	object	Each item	Represents one member source entry for the user group, including the source type, identifier, and optional flags for subordinates or sub-territories. Additional keys: not allowed
$ (anyOf 1).sources[].source	object	Required within parent	Represents the identifier and name of the source. Additional keys: not allowed
$ (anyOf 1).sources[].source.id	string	Required within parent	Represents the unique ID of the user, role, territory, or group configured as a member source. Maximum length: 19
$ (anyOf 1).sources[].source.name	string	Required within parent	Represents the name of the source configured as a member. Maximum length: 250
$ (anyOf 1).sources[].sub_territories	boolean	Optional	Indicates whether members from sub-territories are included for territory-type sources. Present when configured during group creation or update.
$ (anyOf 1).sources[].subordinates	boolean	Optional	Indicates whether users in subordinate roles are included for role-type sources. Present when configured during group creation or update.
$ (anyOf 1).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
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

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