Zoho: Specific Territory User

← Territory users operations · Get started

Operation zoho.getuserdetailsfromterritory

Provider route: GET /crm/v8/settings/territories/{territory}/users/{user}. 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["territoryUsers"]["getUserDetailsFromTerritory"]>[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.territoryUsers.getUserDetailsFromTerritory(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.territory_users.get_user_details_from_territory(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	Model	Required within parent	Expand Specific Territory User — request body — path

Referenced models: Specific Territory User — request body — path

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	Represents the success response body containing the details of the specified user associated with the territory. Additional keys: not allowed
$ (anyOf 1).info	Model	Required within parent	Expand Specific Territory User — response body — info, users info
$ (anyOf 1).users	array	Required within parent	Represents the list of users associated with the territory. Maximum items: 100
$ (anyOf 1).users[]	Model	Each item	Expand Specific Territory User — response body — info, users users item Represents an individual user record associated with the territory.
$ (anyOf 2)	null	Alternative

Referenced models: Specific Territory User — response body — info, users users item, Specific Territory User — response body — info, users info

Schemas

1 more schema is linked from the tables above, on the schema pages.

Specific Territory User — response body — info, users info

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination metadata for the response. Additional keys: not allowed
count	JSON	Required within parent
count (anyOf 1)	integer	Alternative	Represents the total number of records returned. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_records	boolean	Required within parent	Indicates whether there are more records available beyond the current page.
page	JSON	Required within parent
page (anyOf 1)	integer	Alternative	Represents the current page number. 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 number of records per page. Format: int32
per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Specific Territory User — request body — path

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
territory	string	Required within parent	Territory Id Param in URL. Use the [Get Territories API](territories.yaml#$.paths./settings/territories.get) to retrieve the territory ID. Maximum length: 100
user	string	Required within parent	Represents the unique ID of the user as a string, with a maximum length of 100 characters. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve the user ID. Maximum length: 100

Specific Territory User — response body — info, users users item theme normal tab

Field	Type	Presence	Description and constraints
$	object	Root	Represents the normal tab theme settings. Additional keys: not allowed
background	string	Required within parent	Represents the background color of the normal tab in hexadecimal format. Maximum length: 7 Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
font_color	string	Required within parent	Represents the font color of the normal tab in hexadecimal format. Maximum length: 7 Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

Specific Territory User — response body — info, users users item theme selected tab

Field	Type	Presence	Description and constraints
$	object	Root	Represents the selected tab theme settings. Additional keys: not allowed
background	string	Required within parent	Represents the background color of the selected tab in hexadecimal format. Maximum length: 7 Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
font_color	string	Required within parent	Represents the font color of the selected tab in hexadecimal format. Maximum length: 7 Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

Policy, approvals and errors

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