Zoho: Get user groups
Zoho userGroups.getUserGroups: arguments, response, policy and SDK examples.
← User groups operations · Get started
Operation zoho.getusergroups
Provider route: GET /crm/v8/settings/user_groups. 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"]["getUserGroups"]>[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.getUserGroups(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_user_groups(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.filters | string | Optional | Maximum length: 250 |
query.include | string | Optional | One of: sources_count, sources |
query.ids | string | Optional | Maximum length: 250 |
query.name | string | Optional | Maximum length: 250 |
query.page | integer | Optional | Default: 1 Format: int32 Minimum: 1 |
query.per_page | integer | Optional | Default: 200 Format: int32 Maximum: 200 Minimum: 1 |
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 | Represents the successful response for retrieving the list of user groups in the Zoho CRM organization, containing a paginated array of user group objects and pagination metadata. Additional keys: not allowed |
$ (anyOf 1).info | object | Required within parent | Represents the pagination metadata for the current page of results. Additional keys: not allowed |
$ (anyOf 1).info.count | JSON | Required within parent | |
$ (anyOf 1).info.count (anyOf 1) | integer | Alternative | Represents the number of user group records returned in the current page. Format: int32 |
$ (anyOf 1).info.count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).info.more_records | boolean | Required within parent | Indicates whether additional pages of user group records are available beyond the current page. Possible values: true - More records are available on subsequent pages. false - No more records remain after the current page. |
$ (anyOf 1).info.page | JSON | Required within parent | |
$ (anyOf 1).info.page (anyOf 1) | integer | Alternative | Represents the current page number in the paginated response. Format: int32 |
$ (anyOf 1).info.page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).info.per_page | JSON | Required within parent | |
$ (anyOf 1).info.per_page (anyOf 1) | integer | Alternative | Represents the number of user group records returned per page. Format: int32 |
$ (anyOf 1).info.per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).user_groups | array | Required within parent | Represents the list of user group objects returned for the current page. Maximum items: 200 |
$ (anyOf 1).user_groups[] | object | Each item | Represents a single user group configured in the Zoho CRM organization, including its name, description, member sources, and creation and modification metadata. Additional keys: not allowed |
$ (anyOf 1).user_groups[].created_by | object | Required within parent | Represents the CRM 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 CRM user who created the user group. Maximum length: 19 |
$ (anyOf 1).user_groups[].created_by.name | string | Required within parent | Represents the display name of the CRM user who created the user 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 description of the user group, or null if no description was provided. |
$ (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 this user group. |
$ (anyOf 1).user_groups[].id | string | Required within parent | Represents the unique ID of the user group. Maximum length: 19 |
$ (anyOf 1).user_groups[].modified_by | JSON | Required within parent | Represents the CRM user who last modified this user group, or null if the group has not been modified since creation. |
$ (anyOf 1).user_groups[].modified_by (anyOf 1) | object | Alternative | Represents the CRM user who last modified the user group, containing the user ID and display name. Additional keys: not allowed |
$ (anyOf 1).user_groups[].modified_by (anyOf 1).id | string | Required within parent | Represents the unique ID of the CRM user who last modified the user group. Maximum length: 19 |
$ (anyOf 1).user_groups[].modified_by (anyOf 1).name | string | Required within parent | Represents the display name of the CRM user who last modified the user group. Maximum length: 512 |
$ (anyOf 1).user_groups[].modified_by (anyOf 2) | null | Alternative | Indicates that the user group has not been modified since its creation. |
$ (anyOf 1).user_groups[].modified_time | JSON | Required within parent | Represents the date and time at which the user group was last modified, in ISO 8601 format, or null if the group has not been modified since creation. |
$ (anyOf 1).user_groups[].modified_time (anyOf 1) | string | Alternative | Represents the date and time of the most recent modification to the user group, in ISO 8601 format. Format: date-time |
$ (anyOf 1).user_groups[].modified_time (anyOf 2) | null | Alternative | Indicates that the user group has not been modified since its 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 for the user group, categorized by source type. Returned when the include parameter is set to 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 other user groups configured as member sources of this group. 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 CRM roles configured as member sources of this group. 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 CRM territories configured as member sources of this group. 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 CRM users configured as member sources of this group, categorized by user status. 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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getusergroups. Catalog operation: getUserGroups. 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]