Zoho: Get Automation Functions
Zoho automationFunctions.getAllAutomationFunctions: arguments, response, policy and SDK examples.
← Automation functions operations · Get started
Operation zoho.getallautomationfunctions
Provider route: GET /crm/v8/settings/automation/functions. 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["automationFunctions"]["getAllAutomationFunctions"]>[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.automationFunctions.getAllAutomationFunctions(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.automation_functions.get_all_automation_functions(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.module | string | Optional | Maximum length: 200 |
query.feature_type | string | Optional | One of: workflow, approval_process, blueprint, blueprint_transition, blueprint_state, review_process, orchestration, assignment_rules, kiosk, pathfinder, connected_workflows, commandcenter_service, cadences Maximum length: 22 |
query.page | integer | Optional | Default: 1 Format: int32 Minimum: 1 |
query.per_page | integer | Optional | Default: 200 Format: int32 Maximum: 200 Minimum: 1 |
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 Get Automation Functions — response body |
Referenced models: Get Automation Functions — response body
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
Get Automation Functions — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response for an automation functions list request, including the list of functions and pagination information. Additional keys: not allowed |
functions | array | Required within parent | Represents the list of automation functions returned in the response. Maximum items: 200 |
functions[] | Model | Each item | Expand Get Automation Functions — response body — functions item |
info | Model | Required within parent | Expand Get Automation Functions — response body — info |
Referenced models: Get Automation Functions — response body — functions item, Get Automation Functions — response body — info
Get Automation Functions — response body — functions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details of an automation function, including its metadata, module context, script reference, language, lock status, ownership, and configured arguments. Additional keys: not allowed |
arguments | array | Optional | Represents the list of arguments configured for the automation function. Maximum items: 50 |
arguments[] | Model | Each item | Expand Get Automation Functions — response body — functions item arguments item |
associated | boolean | Required within parent | Indicates whether the automation function is currently associated with a workflow or action. Possible values: * **true** - The automation function is associated with a workflow or action. * **false** - The automation function is not associated with any workflow or action. |
created_by | Model | Required within parent | Expand Get Automation Functions — response body — functions item created by |
created_time | string | Required within parent | The timestamp when the automation function was created. Maximum length: 255 |
deletable | boolean | Required within parent | Indicates whether the automation function can be deleted. Possible values: * **true** - The automation function can be deleted. * **false** - The automation function cannot be deleted." |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | A brief description of the automation function's purpose. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | A brief description of the automation function's purpose. Maximum length: 5000 |
editable | boolean | Required within parent | Indicates whether the automation function can be edited. Possible values: * **true** - The automation function can be edited. * **false** - The automation function cannot be edited. |
feature_type | string | Required within parent | The feature type classification of the automation function. Possible values: * **workflow** * **approval_process** * **blueprint** * **blueprint_transition** * **blueprint_state** * **review_process** * **orchestration** * **assignment_rules** * **kiosk** * **pathfinder** * **connected_workflows** * **commandcenter_service** * **cadences** Known values: workflow, approval_process, blueprint, blueprint_transition, blueprint_state, review_process, orchestration, assignment_rules, kiosk, pathfinder, connected_workflows, commandcenter_service, cadences Maximum length: 22 |
function | Model | Required within parent | Expand Get Automation Functions — response body — functions item function |
id | string | Required within parent | Represents the unique identifier of the automation function. Format: int64 |
language | string | Required within parent | The programming language used in the automation function script. Possible values: * **deluge** - Deluge scripting language. * **python** - Python language. * **java** - Java language. **node_js** - Node.js runtime. * **python_3_12** - Python 3.12 runtime. * **java17** - Java 17 runtime. * **nodejs_22** - Node.js 22 runtime. * **nodejs** - Node.js runtime. * **GOlang** - Go programming language. Known values: deluge, python, java, node_js, python_3_12, java17, nodejs_22, nodejs, GOlang Maximum length: 255 |
lock_status | Model | Required within parent | Expand Get Automation Functions — response body — functions item lock status |
modified_by | Model | Required within parent | Expand Get Automation Functions — response body — functions item modified by |
modified_time | string | Required within parent | The timestamp when the automation function was last modified. Maximum length: 255 |
module | Model | Required within parent | Expand Get Automation Functions — response body — functions item module |
name | string | Required within parent | Represents the display name of the automation function. Maximum length: 250 |
related_module | JSON | Optional | The CRM module associated with the automation function, if applicable. |
related_module (anyOf 1) | null | Alternative | Indicates no related module is associated with this automation function. |
related_module (anyOf 2) | Model | Alternative | Expand Get Automation Functions — response body — functions item module |
source | string | Required within parent | The source or origin from which the automation function was created. Maximum length: 255 |
Referenced models: Get Automation Functions — response body — functions item lock status, Get Automation Functions — response body — functions item module, Get Automation Functions — response body — functions item function, Get Automation Functions — response body — functions item created by, Get Automation Functions — response body — functions item modified by, Get Automation Functions — response body — functions item arguments item
Get Automation Functions — response body — info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the pagination metadata returned with list responses, including the number of records per page, total record count, current page number, and whether additional records are available. Additional keys: not allowed |
count | JSON | Required within parent | |
count (anyOf 1) | integer | Alternative | Represents the total number of records in the current page. Format: int32 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
more_records | boolean | Required within parent | Indicates whether additional records are available beyond the current page. Possible values: **true** - Additional records exist beyond the current page. **false** - No additional records exist beyond the current page. |
page | JSON | Required within parent | |
page (anyOf 1) | integer | Alternative | Represents the current page number in the paginated response. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
per_page | JSON | Required within parent | |
per_page (anyOf 1) | integer | Alternative | Represents the number of records returned per page in the response. Format: int32 |
per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get Automation Functions — response body — functions item lock status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The lock status of an automation function, indicating whether editing is currently restricted. Additional keys: not allowed |
locked | boolean | Required within parent | Indicates whether the automation function is currently locked from editing. Possible values: * **true** - The automation function is locked and cannot be edited. * **false** - The automation function is unlocked and available for editing. |
Get Automation Functions — response body — functions item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Module metadata associated with the automation function, including singular and plural labels, API name, internal name, and identifier. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the module associated with the automation function. Maximum length: 255 |
id | string | Required within parent | The unique identifier of the module associated with the automation function. Format: int64 |
moduleName | string | Optional | Represents the internal name of the module. Maximum length: 255 |
plural_label | string | Optional | Represents the plural display label of the module. Maximum length: 255 |
singular_label | string | Optional | Represents the singular display label of the module. Maximum length: 255 |
Get Automation Functions — response body — functions item function
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reference to the underlying function by API name and identifier. Additional keys: not allowed |
api_name | string | Optional | Represents the API name of the automation function. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the automation function. Format: int64 |
Get Automation Functions — response body — functions item created by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A minimal reference to the user who created the automation function, including the user ID and display name. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the user who created the automation function. Format: int64 |
name | string | Required within parent | Represents the display name of the user who created the automation function. Maximum length: 255 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getallautomationfunctions. Catalog operation: getAllAutomationFunctions. 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.