Zoho: Function Categories
Zoho functions.getCategories: arguments, response, policy and SDK examples.
← Functions operations · Get started
Operation zoho.getcategories
Provider route: GET /crm/v8/settings/functions/__schemas/categories. 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["functions"]["getCategories"]>[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.functions.getCategories(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.functions.get_categories(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
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 |
|---|---|---|---|
$ | Model | Root | Expand Function Categories — response body |
Referenced models: Function Categories — response body
Schemas
Section titled “Schemas”Function Categories — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the successful response for retrieving the list of available categories in the Zoho CRM organization. Additional keys: not allowed |
categories | array | Required within parent | Represents the list of categories available in the Zoho CRM organization. Maximum items: 100 |
categories[] | Model | Each item | Expand Function Categories — response body — categories item |
Referenced models: Function Categories — response body — categories item
Function Categories — response body — categories item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a function category entry, including its name and whether it is allowed for the current account. Additional keys: not allowed |
allowed | boolean | Required within parent | Indicates whether functions of this category can be created in the current account. Possible values: **true** - Functions of this category are allowed. **false** - Functions of this category are not allowed. |
category | string | Required within parent | Represents the category of the function. Possible values: **Button** - A function triggered by a button action. **Automation** - A function triggered by an automation rule. **Schedule** - A function triggered on a scheduled basis. **Related List** - A function associated with a related list. **Standalone** - A function that runs independently. **Signals** - A function triggered by Signals notifications. **Validation Rule** - A function associated with a Validation Rule. **Dynamic** - A function that executes dynamically. Known values: Button, Automation, Schedule, Related List, Standalone, Signals, Validation Rule, Dynamic |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getcategories. Catalog operation: getCategories. 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.