Zoho: Specific territory of a user

← Users territories operations · Get started

Operation zoho.getspecificterritoryofuser

Provider route: GET /crm/v8/users/{user}/territories/{territory}. 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["usersTerritories"]["getSpecificTerritoryOfUser"]>[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.usersTerritories.getSpecificTerritoryOfUser(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.users_territories.get_specific_territory_of_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	Format: int64
path.territory	string	Required within parent	Format: int64

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 territories of a user — response body — info, territories
$ (anyOf 2)	null	Alternative

Referenced models: Get territories of a user — response body — info, territories

Schemas

Get territories of a user — response body — info, territories

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response containing territories assigned to a user and pagination details. Additional keys: not allowed
info	object	Required within parent	Represents the pagination details for the response. Additional keys: not allowed
info.count	JSON	Required within parent
info.count (anyOf 1)	integer	Alternative	Represents the number of territory records returned in the current page. Format: int32
info.count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
info.more_records	boolean	Required within parent	Indicates whether more territory records are available beyond the current page. Possible values: true - More records are available. false - No more records are available.
info.page	JSON	Required within parent
info.page (anyOf 1)	integer	Alternative	Represents the current page number in the paginated response. Format: int32
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 maximum number of records returned per page. Format: int32
info.per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
territories	array	Required within parent	The JSON array representing the list of territories assigned to the user. Maximum items: 200 Minimum items: 0 Unique items: true
territories[]	Model	Each item	Expand Get territories of a user — response body — info, territories territories item

Referenced models: Get territories of a user — response body — info, territories territories item

Get territories of a user — response body — info, territories territories item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of a single territory assigned to the user. Additional keys: not allowed
Manager	object	Required within parent	Represents the manager of the territory. Valid user IDs and names can be retrieved using the [Get Users](users.json#$.paths./{users}.get) API. Additional keys: not allowed
Manager.Name	string	Optional	Represents the full name of the territory manager. Maximum length: 255
Manager.id	string	Optional	Represents the unique ID of the territory manager. Format: int64
Name	string	Required within parent	Represents the name of the territory. Maximum length: 255
Reporting_To	object	Required within parent	Represents the parent territory that this territory reports to in the hierarchy. Additional keys: not allowed
Reporting_To.Name	string	Required within parent	Represents the name of the parent territory or reporting entity. Maximum length: 255
Reporting_To.id	string	Required within parent	Represents the unique ID of the parent territory or reporting entity. Format: int64
id	string	Required within parent	Represents the unique ID of the territory. Format: int64

Policy, approvals and errors

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