Zoho CRM: Territory Users Get Territory Users

List the users assigned to a Zoho CRM territory.

Tool ID: zoho_crm_territory_users_get_territory_users

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_territory_users_get_territory_users',
  {
    "territory": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute zoho_crm_territory_users_get_territory_users --input '{
  "territory": "example"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "users": [
      {
        "id": "id_123",
        "first_name": "Jane",
        "full_name": "Example",
        "status": "inactive",
        "category": "regular_user",
        "profile": {
          "id": "id_123",
          "name": "Example"
        },
        "role": {
          "id": "id_123",
          "name": "Example"
        },
        "created_by": {
          "id": "id_123",
          "name": "Example"
        },
        "created_time": "2026-01-15T12:00:00Z",
        "Modified_By": {
          "id": "id_123",
          "name": "Example"
        },
        "Modified_Time": "2026-01-15T12:00:00Z",
        "language": "en",
        "locale": "example",
        "zuid": "example"
      }
    ],
    "info": {
      "per_page": 123,
      "count": 123,
      "page": 123,
      "more_records": true
    }
  }
}

Use deepline describe zoho_crm_territory_users_get_territory_users --json for the latest machine-readable contract.

Input reference

Return users for a territory.

Name	Type	Required	Default	Details
`payload.territory`	`string`	Yes	—	The ID of the territory. Maximum length: 100.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	The `schema` field of type `object`.
`result.data.users`	`array`	Yes	—	The `users` property. Maximum items: 100.
`result.data.users[].id`	`string`	Yes	—	Unique identifier for the user. Maximum length: 100.
`result.data.users[].first_name`	`string`	Yes	—	User’s first name. Maximum length: 50.
`result.data.users[].last_name`	`string \| null`	No	—	User’s last name (optional). Maximum length: 50.
`result.data.users[].full_name`	`string`	Yes	—	User’s full name. Maximum length: 200.
`result.data.users[].country`	`string \| null`	No	—	User’s country. Maximum length: 100.
`result.data.users[].state`	`string \| null`	No	—	User’s state/province. Maximum length: 100.
`result.data.users[].city`	`string \| null`	No	—	User’s city. Maximum length: 100.
`result.data.users[].zip`	`string \| null`	No	—	User’s postal/zip code. Maximum length: 30.
`result.data.users[].fax`	`string \| null`	No	—	User’s fax number. Maximum length: 30.
`result.data.users[].street`	`string \| null`	No	—	User’s street address. Maximum length: 250.
`result.data.users[].status`	`"inactive" \| "deleted" \| "rejected" \| "active" \| "closed" \| "disabled"`	Yes	—	User’s account status. Allowed: `inactive`, `deleted`, `rejected`, `active`, `closed`, `disabled`.
`result.data.users[].category`	`"regular_user" \| "sandbox_user" \| "light_user"`	Yes	—	User’s category/type. Allowed: `regular_user`, `sandbox_user`, `light_user`.
`result.data.users[].profile`	`object`	Yes	—	User’s profile.
`result.data.users[].profile.id`	`string`	Yes	—	Profile ID. Maximum length: 100.
`result.data.users[].profile.name`	`string`	Yes	—	Profile name. Maximum length: 100.
`result.data.users[].role`	`object`	Yes	—	User’s role.
`result.data.users[].role.id`	`string`	Yes	—	Role ID. Maximum length: 100.
`result.data.users[].role.name`	`string`	Yes	—	Role name. Maximum length: 100.
`result.data.users[].created_by`	`object`	Yes	—	User who created this account.
`result.data.users[].created_by.id`	`string`	Yes	—	Creator’s ID. Maximum length: 100.
`result.data.users[].created_by.name`	`string`	Yes	—	Creator’s full name. Maximum length: 200.
`result.data.users[].created_time`	`string`	Yes	—	When the user account was created. Format: `date-time`.
`result.data.users[].Modified_By`	`object`	Yes	—	User who last modified this account.
`result.data.users[].Modified_By.id`	`string`	Yes	—	Modifier’s ID. Maximum length: 100.
`result.data.users[].Modified_By.name`	`string`	Yes	—	Modifier’s full name. Maximum length: 200.
`result.data.users[].Modified_Time`	`string`	Yes	—	When the user account was last modified. Format: `date-time`.
`result.data.users[].language`	`string`	Yes	—	User’s preferred language. Maximum length: 50.
`result.data.users[].locale`	`string`	Yes	—	User’s locale. Maximum length: 50.
`result.data.users[].time_zone`	`string`	No	—	User’s time zone. Maximum length: 50.
`result.data.users[].time_format`	`"HH:mm" \| "hh:mm a"`	No	—	User’s preferred time format. Allowed: `HH:mm`, `hh:mm a`.
`result.data.users[].date_format`	`string`	No	—	User’s preferred date format. Maximum length: 50.
`result.data.users[].decimal_separator`	`"Comma" \| "Period"`	No	—	User’s preferred decimal separator. Allowed: `Comma`, `Period`.
`result.data.users[].number_separator`	`string`	No	—	User’s preferred number separator. Maximum length: 10.
`result.data.users[].country_locale`	`string`	No	—	User’s country locale. Maximum length: 50.
`result.data.users[].microsoft`	`boolean`	No	—	Whether user has Microsoft integration enabled.
`result.data.users[].sandboxDeveloper`	`boolean`	No	—	Whether user is a sandbox developer.
`result.data.users[].personal_account`	`boolean`	No	—	Whether this is a personal account.
`result.data.users[].Isonline`	`boolean`	No	—	Whether user is currently online.
`result.data.users[].confirm`	`boolean`	No	—	Whether user has confirmed their account.
`result.data.users[].offset`	`integer`	No	—	Time zone offset in milliseconds. Format: `int32`.
`result.data.users[].zuid`	`string`	Yes	—	Zoho user ID. Maximum length: 100.
`result.data.users[].alias`	`string \| null`	No	—	User’s alias. Maximum length: 50.
`result.data.users[].dob`	`string \| null`	No	—	User’s date of birth. Format: `date`.
`result.data.users[].website`	`string \| null`	No	—	User’s website. Maximum length: 250. Pattern: `[a-z0-9]{5}[.]com`.
`result.data.users[].signature`	`string \| null`	No	—	User’s signature. Maximum length: 200.
`result.data.users[].name_format__s`	`"First Name,Last Name,Salutation" \| "Salutation,First Name,Last Name" \| "First Name,Salutation,Last Name" \| "Last Name,Salutation,First Name" \| "Salutation,Last Name,First Name" \| "Last Name,First Name,Salutation"`	No	—	User’s preferred name format. Allowed: `First Name,Last Name,Salutation`, `Salutation,First Name,Last Name`, `First Name,Salutation,Last Name`, `Last Name,Salutation,First Name`, `Salutation,Last Name,First Name`, `Last Name,First Name,Salutation`.
`result.data.users[].sort_order_preference__s`	`string`	No	—	User’s sort order preference. Maximum length: 50.
`result.data.users[].status_reason__s`	`string \| null`	No	—	Reason for user’s status. Maximum length: 100.

The table shows the first 50 fields. Expand the raw schema below for every field.

This output schema is too large for an inline display. Read the complete live contract with deepline describe zoho_crm_territory_users_get_territory_users --json.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation