Skip to content

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.

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 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.functions.get_categories(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Function Categories — response body

Referenced models: Function Categories — response body

Function Categories — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents the successful response for retrieving the list of available categories in the Zoho CRM organization.
Additional keys: not allowed
categoriesarrayRequired within parentRepresents the list of categories available in the Zoho CRM organization.
Maximum items: 100
categories[]ModelEach itemExpand Function Categories — response body — categories item

Referenced models: Function Categories — response body — categories item

Function Categories — response body — categories item
FieldTypePresenceDescription and constraints
$objectRootRepresents a function category entry, including its name and whether it is allowed for the current account.
Additional keys: not allowed
allowedbooleanRequired within parentIndicates 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.
categorystringRequired within parentRepresents 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

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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.