Zoho: List portal users

← Portal users operations · Get started

Operation zoho.getportalusers

Provider route: GET /crm/v8/settings/portals/{portal}/user_type/{userType}/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["portalUsers"]["getPortalUsers"]>[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.portalUsers.getPortalUsers(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.portal_users.get_portal_users(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.portal	string	Required within parent	Represents the unique name of the portal. Maximum length: 255
path.userType	integer	Required within parent	Represents the unique numeric identifier of the portal user type. Format: int64 Maximum length: 255
query	object	Optional	Additional keys: not allowed
query.page	integer	Optional	Format: int32
query.per_page	integer	Optional	Format: int32
query.Source__s	string	Optional	Maximum length: 255
query.filters	string	Optional	Maximum length: 255
query.personality_ids	string	Optional	Maximum length: 255
query.type	string	Optional	Maximum length: 255

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 containing the list of portal users and pagination metadata. Additional keys: not allowed
$ (anyOf 1).info	object	Required within parent	Represents pagination metadata for the response. Additional keys: not allowed
$ (anyOf 1).info.total_count	JSON	Required within parent
$ (anyOf 1).info.total_count (anyOf 1)	integer	Alternative	Represents the total number of portal users available for the specified portal and user type. Format: int32
$ (anyOf 1).info.total_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).users	array	Required within parent	Represents the list of portal user objects. Maximum items: 10000
$ (anyOf 1).users[]	object	Each item	Represents a single portal user and their associated attributes. Additional keys: not allowed
$ (anyOf 1).users[].Source__s	string	Required within parent	Represents the source of the portal user record. Maximum length: 255
$ (anyOf 1).users[].active	boolean	Required within parent	Indicates whether the portal user is currently active. Possible values: true, false.
$ (anyOf 1).users[].confirm	boolean	Required within parent	Indicates whether the portal user has confirmed their account. Possible values: true, false.
$ (anyOf 1).users[].created_time	string	Required within parent	Represents the date and time of portal user creation. Format: date-time
$ (anyOf 1).users[].email	string	Required within parent	Represents the email address of the portal user. Format: email
$ (anyOf 1).users[].module	string	Required within parent	Represents the API name of the CRM module associated with the portal user. Maximum length: 100
$ (anyOf 1).users[].name	string	Required within parent	Represents the full name of the portal user. Maximum length: 255
$ (anyOf 1).users[].personality_id	string	Required within parent	Represents the unique identifier of the portal user record. Maximum length: 255
$ (anyOf 1).users[].status_reason__s	string	Required within parent	Represents the reason for the current status of the portal user. Maximum length: 500
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

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