Zoho: Get territory-associated user counts

← Territories operations · Get started

Operation zoho.getterritoryassociateduserscount

Provider route: GET /crm/v8/settings/territories/actions/associated_users_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["territories"]["getTerritoryAssociatedUsersCount"]>[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.territories.getTerritoryAssociatedUsersCount(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.territories.get_territory_associated_users_count(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.page	integer	Optional	Page number as an integer, starting from 1. Format: int32 Minimum: 1
query.per_page	integer	Optional	Represents the per page number. Format: int32 Maximum: 2000 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)	Model	Alternative	Expand Get territory-associated user counts — response body — associated users count, info
$ (anyOf 2)	null	Alternative

Referenced models: Get territory-associated user counts — response body — associated users count, info

Schemas

Get territory-associated user counts — response body — associated users count, info

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response containing the count of users associated with each territory. Additional keys: not allowed
associated_users_count	array	Required within parent	Represents the list of objects containing the count of users associated with each territory. Maximum items: 200 Minimum items: 1
associated_users_count[]	object	Each item	Represents the error details for a single territory with its associated user count. Additional keys: not allowed
associated_users_count[].count	JSON	Required within parent
associated_users_count[].count (anyOf 1)	integer	Alternative	Represents the total number of users associated with the territory. Format: int32 Minimum: 0
associated_users_count[].count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
associated_users_count[].territory	object	Required within parent	Represents the territory object associated with the user count. Additional keys: not allowed
associated_users_count[].territory.id	string	Required within parent	Represents the unique identifier of the territory. Format: int64
associated_users_count[].territory.name	string	Required within parent	Represents the display name of the territory. Maximum length: 50
info	object	Required within parent	Represents the pagination metadata for the response. Additional keys: not allowed
info.count	JSON	Required within parent
info.count (anyOf 1)	integer	Alternative	Represents the total number of records available in the current response. Format: int32 Minimum: 0
info.count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
info.more_records	boolean	Required within parent	Represents whether additional records are available beyond the current page.
info.page	JSON	Required within parent
info.page (anyOf 1)	integer	Alternative	Represents the current page number in the paginated response. Format: int32 Minimum: 1
info.page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
info.per_page	JSON	Required within parent
info.per_page (anyOf 1)	integer	Alternative	Represents the number of records returned per page. Format: int32 Maximum: 2000 Minimum: 1
info.per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

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