Zoho: Portal User Type — portal User Type get Portal User Type

← Portal user type operations · Get started

Operation zoho.getportalusertype

Provider route: GET /crm/v8/settings/portals/{portal}/user_type/{userTypeId}. 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["portalUserType"]["getPortalUserType"]>[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.portalUserType.getPortalUserType(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_user_type.get_portal_user_type(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.userTypeId	string	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.include_inner_details	string	Optional	One of: field.field_label

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
$	Model	Root	Expand Portal User Type — portal User Type get Portal User Type — response body

Referenced models: Portal User Type — portal User Type get Portal User Type — response body

Schemas

6 more schemas are linked from the tables above, on the schema pages.

Portal User Type — portal User Type get Portal User Type — response body

Field	Type	Presence	Description and constraints
$	object	Root	Returned on a successful request to retrieve a single portal user type by ID. Contains the full configuration of the requested user type. Additional keys: not allowed
user_type	array	Required within parent	An array containing the full configuration of the requested portal user type. Always contains exactly one entry. Maximum items: 1
user_type[]	Model	Each item	Expand Portal User Type — portal User Type get Portal User Type — response body — user type item

Referenced models: Portal User Type — portal User Type get Portal User Type — response body — user type item

Portal User Type — portal User Type get Portal User Type — response body — user type item

Field	Type	Presence	Description and constraints
$	object	Root	The full configuration details of a single portal user type, including identity fields, active status, user counts, audit metadata, and per-module access permissions. Additional keys: not allowed
active	boolean	Required within parent	Indicates whether the portal user type is currently active and available to portal users.
active_user_count	JSON	Required within parent
active_user_count (anyOf 1)	integer	Alternative	Represents the number of portal users currently assigned to and active under this user type. Format: int32
active_user_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deactive_user_count	JSON	Required within parent
deactive_user_count (anyOf 1)	integer	Alternative	Represents the number of portal users assigned to this user type who have been deactivated. Format: int32
deactive_user_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
default	boolean	Required within parent	Whether this is the default portal user type in the organization. The default user type is automatically assigned when no explicit user type is specified.
id	string	Required within parent	Represents the unique numeric identifier of the portal user type. Format: int64 Maximum length: 255
invitation_field	Model	Required within parent	Expand Portal User Types — response body — user type item invitation field
modules	array	Required within parent	The list of CRM modules that portal users of this type are permitted to access, along with the permissions and layouts configured for each module. Maximum items: 500
modules[]	Model	Each item	Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item
name	string	Required within parent	Represents the name of the portal user type. Maximum length: 255
personality_module	Model	Required within parent	Expand Portal User Types — response body — user type item personality module

Referenced models: Portal User Types — response body — user type item invitation field, Portal User Types — response body — user type item personality module, Portal User Type — portal User Type get Portal User Type — response body — user type item modules item

Portal User Types — response body — user type item invitation field

Field	Type	Presence	Description and constraints
$	object	Root	The invitation field configured for the portal user type. This is the CRM field used to store the portal user's email address, to which portal invitations are sent. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the CRM field designated as the invitation field for sending portal invitations. Maximum length: 255
id	string	Required within parent	Represents the unique numeric identifier of the invitation field in Zoho CRM. Format: int64 Maximum length: 255

Portal User Types — response body — user type item personality module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the nested object identifying the personality module configured for the portal user type. The personality module is the CRM module (for example, Contacts) whose records serve as portal user identities. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the CRM module configured as the personality module for this portal user type. Maximum length: 255
id	string	Required within parent	Represents the unique numeric identifier of the personality module in Zoho CRM. Format: int64 Maximum length: 255
plural_label	string	Required within parent	Represents the plural label of the module. Maximum length: 255

Portal User Type — portal User Type get Portal User Type — response body — user type item modules item filters null item

Field	Type	Presence	Description and constraints
$	object	Root	A nested object representing a filter field available for a module in the portal user type, identified by its unique ID, API name, and display label. Additional keys: not allowed
api_name	string	Optional	Represents the API name that uniquely identifies the filter field within the CRM module. Maximum length: 256
display_label	string	Optional	Represents the display label shown to portal users for the filter field. Maximum length: 50
id	string	Optional	Represents the unique numeric identifier of the filter field in Zoho CRM. Maximum length: 25 Pattern: ^[0-9]+$

Portal User Type — portal User Type get Portal User Type — response body — user type item modules item fields null item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a field that is accessible to portal users for the configured module. Includes the field's unique identifier, API name, read-only flag, and the list of per-field CRUD permissions. Additional keys: not allowed
api_name	string	Optional	The API name of the CRM field accessible to portal users within this module. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Optional	The unique numeric identifier of the CRM field. Format: int64
permissions	array	Optional	Represents the list of CRUD permission entries that control what portal users can do with this field. Maximum items: 25
permissions[]	Model	Each item	Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item fields null item permissions item
read_only	JSON	Optional
read_only (anyOf 1)	boolean	Alternative	Denotes whether the field is read-only for portal users. When `true`, portal users can view the field value but cannot modify it.
read_only (anyOf 2)	null	Alternative	Denotes whether the field is read-only for portal users. When `true`, portal users can view the field value but cannot modify it.

Referenced models: Portal User Type — portal User Type get Portal User Type — response body — user type item modules item fields null item permissions item

Portal User Type — portal User Type get Portal User Type — response body — user type item modules item layouts null item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the nested object representing a CRM layout that portal users can access for a given module. Identified by a unique numeric ID, name, and display label. Additional keys: not allowed
_default_view	Model	Optional	Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item layouts null item default view
display_label	string	Optional	Represents the display label of the CRM layout. Maximum length: 255
id	string	Optional	Specifies the unique identifier of the CRM layout. Maximum length: 25 Pattern: ^[0-9]+$
name	string	Optional	Represents the internal name of the CRM layout. Maximum length: 255

Referenced models: Portal User Type — portal User Type get Portal User Type — response body — user type item modules item layouts null item default view

Portal User Type — portal User Type get Portal User Type — response body — user type item modules item views value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	A nested object representing a list view associated with a portal user type module. Identified by a unique numeric ID, name, display label, and type. Additional keys: not allowed
$ (anyOf 1).display_label	string	Optional	Represents the display label of the list view shown to portal users. Maximum length: 255
$ (anyOf 1).id	string	Optional	Represents the unique identifier of the resource. Maximum length: 25 Pattern: ^[0-9]+$
$ (anyOf 1).name	string	Optional	Represents the name of the resource. Maximum length: 255
$ (anyOf 1).type	string	Optional	The type of the list view. Possible values: `canvas_view` (Canvas View), `custom_view` (Custom List View). Known values: canvas_view, custom_view Maximum length: 255
$ (anyOf 2)	null	Alternative	A nested object representing a list view associated with a portal user type module. Identified by a unique numeric ID, name, display label, and type. Additional keys: not allowed
$ (anyOf 2).display_label	string	Optional	Represents the display label of the list view shown to portal users. Maximum length: 255
$ (anyOf 2).id	string	Optional	Represents the unique identifier of the resource. Maximum length: 25 Pattern: ^[0-9]+$
$ (anyOf 2).name	string	Optional	Represents the name of the resource. Maximum length: 255
$ (anyOf 2).type	string	Optional	The type of the list view. Possible values: `canvas_view` (Canvas View), `custom_view` (Custom List View). Known values: canvas_view, custom_view Maximum length: 255

Policy, approvals and errors

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

Official provider source