Zoho: Get a user group
Zoho userGroups.getGroup: arguments, response, policy and SDK examples.
← User groups operations · Get started
Operation zoho.getgroup
Provider route: GET /crm/v8/settings/user_groups/{group}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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"]["getGroup"]>[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.getGroup(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_group(arguments) result = await call.wait() return result.body_json()| 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 |
query | object | Optional | Additional keys: not allowed |
query.include | string | Optional | One of: sources_count, sources |
query.filters | string | Optional | Maximum length: 250 |
query.ids | string | Optional | Maximum length: 250 |
query.name | string | Optional | Maximum length: 250 |
Response
Section titled “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 details of the specified user group. Additional keys: not allowed |
$ (anyOf 1).info | Model | Optional | Expand Get associated groups for a user — response body — info |
$ (anyOf 1).user_groups | array | Required within parent | Represents an array containing the details of the specified user group. Maximum items: 200 |
$ (anyOf 1).user_groups[] | object | Each item | Represents the details of a user group, including its name, description, creation and modification metadata, and optional member source counts. Additional keys: not allowed |
$ (anyOf 1).user_groups[].created_by | object | Required within parent | Represents the user who created this user group. Additional keys: not allowed |
$ (anyOf 1).user_groups[].created_by.id | string | Required within parent | Represents the unique ID of the user who created this group. Maximum length: 19 |
$ (anyOf 1).user_groups[].created_by.name | string | Required within parent | Represents the name of the user who created this group. Maximum length: 512 |
$ (anyOf 1).user_groups[].created_time | string | Required within parent | Represents the date and time of user group creation, in ISO 8601 format. Format: date-time |
$ (anyOf 1).user_groups[].description | JSON | Required within parent | Represents the text description of the user group. Present in the response when a description was provided during group creation. |
$ (anyOf 1).user_groups[].description (anyOf 1) | string | Alternative | Represents the text description of the user group. Maximum length: 250 |
$ (anyOf 1).user_groups[].description (anyOf 2) | null | Alternative | Indicates that no description was provided for the user group. |
$ (anyOf 1).user_groups[].id | string | Required within parent | Represents the unique identifier of the user group. Maximum length: 19 |
$ (anyOf 1).user_groups[].modified_by | JSON | Required within parent | Represents the user who last modified this user group. |
$ (anyOf 1).user_groups[].modified_by (anyOf 1) | object | Alternative | Represents the user who last modified this group, with their ID and name. Additional keys: not allowed |
$ (anyOf 1).user_groups[].modified_by (anyOf 1).id | string | Required within parent | Represents the unique ID of the user who last modified this group. Maximum length: 19 |
$ (anyOf 1).user_groups[].modified_by (anyOf 1).name | string | Required within parent | Represents the name of the user who last modified this group. Maximum length: 512 |
$ (anyOf 1).user_groups[].modified_by (anyOf 2) | null | Alternative | Indicates that this group has not been modified since creation. |
$ (anyOf 1).user_groups[].modified_time | JSON | Required within parent | Represents the date and time when the user group was last modified. |
$ (anyOf 1).user_groups[].modified_time (anyOf 1) | string | Alternative | Represents the timestamp of the last modification in ISO 8601 format. Format: date-time |
$ (anyOf 1).user_groups[].modified_time (anyOf 2) | null | Alternative | Indicates that the group has not been modified since creation. |
$ (anyOf 1).user_groups[].name | string | Required within parent | Represents the name of the user group. Maximum length: 250 |
$ (anyOf 1).user_groups[].sources_count | object | Optional | Represents the count of member sources by type for this user group. Present when the include query parameter includes sources_count. Additional keys: not allowed |
$ (anyOf 1).user_groups[].sources_count.groups | JSON | Optional | |
$ (anyOf 1).user_groups[].sources_count.groups (anyOf 1) | integer | Alternative | Represents the number of group sources in this user group. Present when sources_count is included. Format: int32 |
$ (anyOf 1).user_groups[].sources_count.groups (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).user_groups[].sources_count.roles | JSON | Optional | |
$ (anyOf 1).user_groups[].sources_count.roles (anyOf 1) | integer | Alternative | Represents the number of role sources in this user group. Present when sources_count is included. Format: int32 |
$ (anyOf 1).user_groups[].sources_count.roles (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).user_groups[].sources_count.territories | JSON | Optional | |
$ (anyOf 1).user_groups[].sources_count.territories (anyOf 1) | integer | Alternative | Represents the number of territory sources in this user group. Present when sources_count is included. Format: int32 |
$ (anyOf 1).user_groups[].sources_count.territories (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).user_groups[].sources_count.users | JSON | Optional | |
$ (anyOf 1).user_groups[].sources_count.users (anyOf 1) | integer | Alternative | Represents the count of individual user sources in this group, broken down by user status. Present when sources_count is included. Format: int32 |
$ (anyOf 1).user_groups[].sources_count.users (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2) | null | Alternative |
Referenced models: Get associated groups for a user — response body — info
Schemas
Section titled “Schemas”Get associated groups for a user — response body — info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents pagination information for the response. Additional keys: not allowed |
count | JSON | Required within parent | |
count (anyOf 1) | integer | Alternative | Represents the total number of user groups returned in the current response. Format: int32 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
more_records | boolean | Required within parent | Indicates whether additional user group records are available beyond the current page. |
page | JSON | Required within parent | |
page (anyOf 1) | integer | Alternative | Represents the current page number in the paginated response. 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 maximum number of user group records returned per page. Format: int32 |
per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getgroup. Catalog operation: getGroup. 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]