Zoho: Portals

← Portals operations · Get started

Operation zoho.getportals

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

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed

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 200 response schema for listing portals, containing the array of portal summary objects. Additional keys: not allowed
$ (anyOf 1).portals	array	Required within parent	Represents the list of portals configured for the organization. Maximum items: 100
$ (anyOf 1).portals[]	object	Each item	Represents the summary details of a single portal. Additional keys: not allowed
$ (anyOf 1).portals[].active	boolean	Required within parent	Indicates whether the portal is active.
$ (anyOf 1).portals[].created_by	object	Required within parent	Represents the Zoho CRM user who created this portal. Additional keys: not allowed
$ (anyOf 1).portals[].created_by.id	string	Required within parent	Represents the unique identifier of the user who created this portal. Maximum length: 255
$ (anyOf 1).portals[].created_by.name	string	Required within parent	Represents the name of the user who created this portal. Maximum length: 255
$ (anyOf 1).portals[].created_time	string	Required within parent	Represents the timestamp when the portal was first added. Format: date-time
$ (anyOf 1).portals[].login_url	string	Optional	Represents the login URL for the portal. Maximum length: 2048
$ (anyOf 1).portals[].modified_by	object	Required within parent	Represents the Zoho CRM user who last modified this portal. Additional keys: not allowed
$ (anyOf 1).portals[].modified_by.id	string	Required within parent	Represents the unique identifier of the user who last modified this portal. Maximum length: 255
$ (anyOf 1).portals[].modified_by.name	string	Required within parent	Represents the name of the user who last modified this portal. Maximum length: 255
$ (anyOf 1).portals[].modified_time	string	Required within parent	Represents the timestamp when the portal configuration was last modified. Format: date-time
$ (anyOf 1).portals[].name	string	Required within parent	Represents the unique name of the portal. Maximum length: 60
$ (anyOf 1).portals[].zaid	string	Required within parent	Represents the Zoho account ID (`zaid`) associated with the portal. Maximum length: 255
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

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