Skip to content

Zoho: Get Automation Function

Zoho automationFunctions.getAutomationFunctions: arguments, response, policy and SDK examples.

← Automation functions operations · Get started

Operation zoho.getautomationfunctions

Provider route: GET /crm/v8/settings/automation/functions/{functionId}. 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["automationFunctions"]["getAutomationFunctions"]>[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.getAutomationFunctions(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.automation_functions.get_automation_functions(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.functionIdstringRequired within parentFormat: int64
Maximum length: 255

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Get Automation Function — response body — functions
$ (anyOf 2)nullAlternative

Referenced models: Get Automation Function — response body — functions

Get Automation Function — response body — functions
FieldTypePresenceDescription and constraints
$objectRootRepresents the response containing automation function records returned for the requested query.
Additional keys: not allowed
functionsarrayRequired within parentThe list of automation function detail records matching the query.
Maximum items: 1
functions[]ModelEach itemExpand Get Automation Functions — response body — functions item

Referenced models: Get Automation Functions — response body — functions item

Get Automation Functions — response body — functions item
FieldTypePresenceDescription and constraints
$objectRootRepresents the details of an automation function, including its metadata, module context, script reference, language, lock status, ownership, and configured arguments.
Additional keys: not allowed
argumentsarrayOptionalRepresents the list of arguments configured for the automation function.
Maximum items: 50
arguments[]ModelEach itemExpand Get Automation Functions — response body — functions item arguments item
associatedbooleanRequired within parentIndicates 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_byModelRequired within parentExpand Get Automation Functions — response body — functions item created by
created_timestringRequired within parentThe timestamp when the automation function was created.
Maximum length: 255
deletablebooleanRequired within parentIndicates whether the automation function can be deleted. Possible values:
* **true** - The automation function can be deleted.
* **false** - The automation function cannot be deleted."
descriptionJSONOptional
description (anyOf 1)stringAlternativeA brief description of the automation function's purpose.
Maximum length: 5000
description (anyOf 2)nullAlternativeA brief description of the automation function's purpose.
Maximum length: 5000
editablebooleanRequired within parentIndicates whether the automation function can be edited. Possible values:
* **true** - The automation function can be edited.
* **false** - The automation function cannot be edited.
feature_typestringRequired within parentThe 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
functionModelRequired within parentExpand Get Automation Functions — response body — functions item function
idstringRequired within parentRepresents the unique identifier of the automation function.
Format: int64
languagestringRequired within parentThe 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_statusModelRequired within parentExpand Get Automation Functions — response body — functions item lock status
modified_byModelRequired within parentExpand Get Automation Functions — response body — functions item modified by
modified_timestringRequired within parentThe timestamp when the automation function was last modified.
Maximum length: 255
moduleModelRequired within parentExpand Get Automation Functions — response body — functions item module
namestringRequired within parentRepresents the display name of the automation function.
Maximum length: 250
related_moduleJSONOptionalThe CRM module associated with the automation function, if applicable.
related_module (anyOf 1)nullAlternativeIndicates no related module is associated with this automation function.
related_module (anyOf 2)ModelAlternativeExpand Get Automation Functions — response body — functions item module
sourcestringRequired within parentThe 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 — functions item lock status
FieldTypePresenceDescription and constraints
$objectRootThe lock status of an automation function, indicating whether editing is currently restricted.
Additional keys: not allowed
lockedbooleanRequired within parentIndicates 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
FieldTypePresenceDescription and constraints
$objectRootModule metadata associated with the automation function, including singular and plural labels, API name, internal name, and identifier.
Additional keys: not allowed
api_namestringRequired within parentRepresents the API name of the module associated with the automation function.
Maximum length: 255
idstringRequired within parentThe unique identifier of the module associated with the automation function.
Format: int64
moduleNamestringOptionalRepresents the internal name of the module.
Maximum length: 255
plural_labelstringOptionalRepresents the plural display label of the module.
Maximum length: 255
singular_labelstringOptionalRepresents the singular display label of the module.
Maximum length: 255
Get Automation Functions — response body — functions item function
FieldTypePresenceDescription and constraints
$objectRootReference to the underlying function by API name and identifier.
Additional keys: not allowed
api_namestringOptionalRepresents the API name of the automation function.
Maximum length: 255
idstringRequired within parentRepresents the unique identifier of the automation function.
Format: int64
Get Automation Functions — response body — functions item created by
FieldTypePresenceDescription and constraints
$objectRootA minimal reference to the user who created the automation function, including the user ID and display name.
Additional keys: not allowed
idstringRequired within parentRepresents the unique identifier of the user who created the automation function.
Format: int64
namestringRequired within parentRepresents the display name of the user who created the automation function.
Maximum length: 255
Get Automation Functions — response body — functions item modified by
FieldTypePresenceDescription and constraints
$objectRootRepresents a reference to the user who last modified a record, including the user's display name and unique ID.
Additional keys: not allowed
idstringRequired within parentRepresents the unique ID of the user who last modified the record.
Format: int64
namestringRequired within parentRepresents the display name of the user who last modified the record.
Maximum length: 255
Get Automation Functions — response body — functions item arguments item
FieldTypePresenceDescription and constraints
$objectRootRepresents name, type and value that defines a single argument passed to an automation function.
Additional keys: not allowed
namestringRequired within parentRepresents the name of the automation function argument.
Maximum length: 100
typestringRequired within parentThe type of the automation function argument. Possible values:
* **static** - The argument uses a fixed, literal value.
* **merge_field** - The argument uses a dynamic value merged from a CRM field.

Known values: static, merge_field
Maximum length: 255
valuestringRequired within parentRepresents the value assigned to the automation function argument.
Maximum length: 1000

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

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.