Zoho: Get source counts for a user group

Zoho userGroups.getUserGroupSourcesCount: arguments, response, policy and SDK examples.

Operation zoho.getusergroupsourcescount

Provider route: GET /crm/v8/settings/user_groups/{group}/actions/sources_count. 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"]["getUserGroupSourcesCount"]>[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.getUserGroupSourcesCount(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_count(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
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative	Response schema containing the source counts for the specified user group. Additional keys: not allowed
`$ (anyOf 1).sources_count`	array	Required within parent	Represents the array containing the member source counts for the specified user group. Maximum items: 1
`$ (anyOf 1).sources_count[]`	object	Each item	Represents the count of each type of member source configured in the user group. Additional keys: not allowed
`$ (anyOf 1).sources_count[].groups`	JSON	Optional
`$ (anyOf 1).sources_count[].groups (anyOf 1)`	integer	Alternative	Represents the number of group sources in this user group. Present when group sources are configured. Format: int32
`$ (anyOf 1).sources_count[].groups (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).sources_count[].roles`	JSON	Optional
`$ (anyOf 1).sources_count[].roles (anyOf 1)`	integer	Alternative	Represents the number of role sources in this user group. Present when role sources are configured. Format: int32
`$ (anyOf 1).sources_count[].roles (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).sources_count[].territories`	JSON	Optional
`$ (anyOf 1).sources_count[].territories (anyOf 1)`	integer	Alternative	Represents the number of territory sources in this user group. Present when territory sources are configured. Format: int32
`$ (anyOf 1).sources_count[].territories (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).sources_count[].users`	object	Optional	Represents the count of individual user sources by status. Present when user sources are configured. Additional keys: not allowed
`$ (anyOf 1).sources_count[].users.active`	JSON	Required within parent
`$ (anyOf 1).sources_count[].users.active (anyOf 1)`	integer	Alternative	Represents the number of active users in this user group. Format: int32
`$ (anyOf 1).sources_count[].users.active (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).sources_count[].users.deleted`	JSON	Required within parent
`$ (anyOf 1).sources_count[].users.deleted (anyOf 1)`	integer	Alternative	Represents the number of deleted users in this user group. Format: int32
`$ (anyOf 1).sources_count[].users.deleted (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).sources_count[].users.inactive`	JSON	Required within parent
`$ (anyOf 1).sources_count[].users.inactive (anyOf 1)`	integer	Alternative	Represents the number of inactive users in this user group. Format: int32
`$ (anyOf 1).sources_count[].users.inactive (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 2)`	null	Alternative

Policy, approvals and errors

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

Report an issue with this page