Zoho: Get users

← Users operations · Get started

Operation zoho.getusers

Provider route: GET /crm/v8/users. 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["users"]["getUsers"]>[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.users.getUsers(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.get_users(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.type	string	Optional	One of: CurrentUser, DeletedUsers, DeactiveUsers, NotConfirmedUsers, ConfirmedUsers, ActiveUsers, AdminUsers, ActiveConfirmedAdmins, ActiveConfirmedUsers, DeveloperUsers, AllUsers, AllActiveUsers, ActiveLiteUser, ActiveAndDeactive, ChildRoleUsers, ParentRoleUsers, SubordinateRoleUsers, ConfirmedReportingUsers
query.page	integer	Optional	Format: int32
query.per_page	integer	Optional	Format: int32
query.include_lite_users	boolean	Optional
query.role_id	string	Optional	Represents the unique ID of the role. Maximum length: 19
query.query_id	string	Optional	Format: int64
query.child_data	object	Optional	Additional keys: allowed
query.child_data.id	string	Required within parent	Record ID of the module with user look up field Format: int64
query.ids	array	Optional	Maximum items: 100 Minimum items: 1
query.ids[]	string	Each item	Represents the unique ID of a user in the Zoho CRM organization. Maximum length: 19
query.fields	string	Optional	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 3000 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
query.type__s	string	Optional	One of: Regular User, Sandbox Developer User, Team User, Digital Employee, Support User, Client Portal User

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	Contains the paginated response for the getUsers operation. Includes a list of user objects and an info object. Additional keys: not allowed
$ (anyOf 1).info	Model	Optional	Expand Get users — response body — info, users info
$ (anyOf 1).users	array	Optional	List of user objects, each representing an individual Zoho CRM user returned by the query. Maximum items: 200
$ (anyOf 1).users[]	Model	Each item	Expand Get a specific user — response body — users users item
$ (anyOf 2)	null	Alternative

Referenced models: Get a specific user — response body — users users item, Get users — response body — info, users info

Schemas

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

Get users — response body — info, users info

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination metadata returned with the user list response, including the current page, records per page, total count, and whether additional pages are available. Additional keys: not allowed
count	JSON	Required within parent
count (anyOf 1)	integer	Alternative	Represents the total number of user records 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 records are available beyond the current page.\n\nPossible values:\ntrue - More records are available on subsequent pages.\nfalse - No more records are available.
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 number of user records returned per page. Format: int32
per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get a specific user — response body — users users item theme header

Field	Type	Presence	Description and constraints
$	object	Root	Represents the theme configuration for the header area of the user's CRM interface. Includes the background color and font color settings for the header. Additional keys: not allowed
background	string	Optional	Represents the background color of the header area in the user's theme. Format: hex-color
font_color	string	Optional	Represents the font color of the header area in the user's theme. Format: hex-color

Get a specific user — response body — users users item theme normal tab

Field	Type	Presence	Description and constraints
$	object	Root	Represents the theme configuration for the normal (unselected) tab in the user's CRM interface, including background color and font color settings. Additional keys: not allowed
background	string	Optional	Represents the background color of the normal tab in the user's theme. Format: hex-color
font_color	string	Optional	Represents the font color of the normal tab in the user's theme. Format: hex-color

Get a specific user — response body — users users item theme selected tab

Field	Type	Presence	Description and constraints
$	object	Root	Represents the theme configuration for the currently selected tab in the user's CRM interface, including background color and font color settings. Additional keys: not allowed
background	string	Optional	Represents the background color of the selected tab in the user's theme. Format: hex-color
font_color	string	Optional	Represents the font color of the selected tab in the user's theme. Format: hex-color

Policy, approvals and errors

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