Skip to content

Zoho: Function — functions get Function

Zoho functions.getFunction: arguments, response, policy and SDK examples.

← Functions operations · Get started

Operation zoho.getfunction

Provider route: GET /crm/v8/settings/functions/{fxIdentifier}. 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"]["getFunction"]>[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.getFunction(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_function(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathModelRequired within parentExpand Publish a function — request body — path

Referenced models: Publish a function — request body — path

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 Function — functions get Function — response body — functions
$ (anyOf 2)nullAlternative

Referenced models: Function — functions get Function — response body — functions

Function — functions get Function — response body — functions
FieldTypePresenceDescription and constraints
$objectRootThe successful response returned when retrieving one or more functions from the Zoho CRM organization.
Additional keys: not allowed
functionsarrayRequired within parentThe list of function metadata objects returned by the operation.
Maximum items: 200
functions[]ModelEach itemExpand Function — functions get Function — response body — functions functions item

Referenced models: Function — functions get Function — response body — functions functions item

Publish a function — request body — path
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fxIdentifierstringRequired within parentMaximum length: 255
fxIdentifier (anyOf 1)JSONAlternativeNumeric identifier of the function.
fxIdentifier (anyOf 1) (allOf 1)stringAll variants applyNumeric identifier of the function.
Format: int64
Maximum length: 19
Minimum length: 5
Pattern: ^[0-9]+$
fxIdentifier (anyOf 2)JSONAlternativeAPI name of the function.
fxIdentifier (anyOf 2) (allOf 1)stringAll variants applyAPI name of the function.
Maximum length: 100
Pattern: ^[A-Za-z][A-Za-z0-9_-]*$
Function — functions get Function — response body — functions functions item
FieldTypePresenceDescription and constraints
$objectRootThe complete metadata for a function, including its identification, configuration, runtime details, state, ownership, and associated tags.
Additional keys: not allowed
TagarrayRequired within parentThe list of tags associated with the function.
Maximum items: 200
Tag[]ModelEach itemExpand Function — functions get Function — response body — functions functions item Tag item
api_namestringRequired within parentRepresents the unique programmatic identifier for the function, used in API calls and automation references.
Maximum length: 100
Pattern: ^[A-Za-z][A-Za-z0-9_-]*$
argumentsJSONRequired within parent
arguments (anyOf 1)arrayAlternativeList of input arguments accepted by the function. Null if the function takes no arguments.
Maximum items: 50
arguments (anyOf 1)[]ModelEach itemExpand Function — functions get Function — response body — functions functions item arguments null item
arguments (anyOf 2)nullAlternativeList of input arguments accepted by the function. Null if the function takes no arguments.
Maximum items: 50
arguments (anyOf 2)[]ModelEach itemExpand Function — functions get Function — response body — functions functions item arguments null item
categorystringRequired within parentThe trigger category that determines how and when the function executes. Possible values: **Related List** - The function is triggered from a related list context. **Validation Rule** - The function executes as part of a Validation Rule. **Schedule** - The function runs on a scheduled basis. **Automation** - The function is triggered by an automation event. **Standalone** - The function runs independently without a trigger context. **Signals** - The function is triggered by a Signals event. **Button** - The function executes when a button is clicked. **Dynamic** - The function operates in a dynamic context.
Known values: Related List, Validation Rule, Schedule, Automation, Standalone, Signals, Button, Dynamic
created_byModelRequired within parentExpand Function — functions get Function — response body — functions functions item created by
created_timestringRequired within parentThe timestamp when the function was created.
Format: date-time
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeThe description of the function's purpose and behavior provided by the user. Null if no description has been set.
Maximum length: 3000
description (anyOf 2)nullAlternativeThe description of the function's purpose and behavior provided by the user. Null if no description has been set.
Maximum length: 3000
has_draftbooleanRequired within parentIndicates whether the function has an unpublished draft version that differs from the currently published version. Possible values: **true** - The function has an unpublished draft version. **false** - The function does not have an unpublished draft version.
idstringRequired within parentThe numeric identifier of the function.
Format: int64
languagestringRequired within parentRepresents the programming language in which this function is written. Possible values: **Deluge** - Zoho's proprietary Deluge scripting language. **Node JS** - JavaScript runtime environment (Node.js). **Java** - Java programming language. **Python** - Python programming language.
Known values: Deluge, Node JS, Java, Python
modified_byModelRequired within parentExpand Function — functions get Function — response body — functions functions item modified by
modified_timestringRequired within parentRepresents the timestamp of the last modification made to the function.
Format: date-time
namestringRequired within parentRepresents the display name of the function.
Maximum length: 100
rest_api_modearrayRequired within parentRepresents the REST API authentication modes enabled for this function.
Maximum items: 3
rest_api_mode[]stringEach itemRepresents an authentication mode identifier for REST API access to this function. Possible values: **Oauth** - OAuth-based authentication is enabled. **ZAPI** - ZAPI key-based authentication is enabled. **None** - No REST API authentication mode is enabled.
Known values: Oauth, ZAPI, None
return_typeJSONRequired within parent
return_type (anyOf 1)stringAlternativeThe data type the function returns when executed. Possible values: **bool** - Boolean return type. **collection** - Collection return type. **date** - Date return type. **float** - Floating-point number return type. **int** - Integer return type. **list** - List return type. **map** - Map return type. **string** - String return type. **void** - No return value. **null** - Return type is not explicitly set.
Known values: bool, collection, date, float, int, list, map, string, void
return_type (anyOf 2)nullAlternativeThe data type the function returns when executed. Possible values: **bool** - Boolean return type. **collection** - Collection return type. **date** - Date return type. **float** - Floating-point number return type. **int** - Integer return type. **list** - List return type. **map** - Map return type. **string** - String return type. **void** - No return value. **null** - Return type is not explicitly set.
Known values: bool, collection, date, float, int, list, map, string, void
runtimestringRequired within parentRepresents the execution runtime environment used to run this function. Possible values: **Deluge 1.0** - Deluge scripting runtime version 1.0. **NodeJS 8** - Node.js runtime version 8. **NodeJS 22** - Node.js runtime version 22. **Java 8** - Java runtime version 8. **Java 17** - Java runtime version 17. **Python 3.12** - Python runtime version 3.12.
Known values: Deluge 1.0, NodeJS 8, NodeJS 22, Java 8, Java 17, Python 3.12
sourcestringRequired within parentRepresents the origin of this function. Possible values: **crm** - The function was created within Zoho CRM. **extension** - The function originates from a Marketplace extension. **private_extension** - The function originates from a private extension.
Known values: crm, extension, private_extension
statestringRequired within parentRepresents the current lifecycle state of the function. Possible values: **active** - The function has a published version. **unpublished** - The function was created but has never been published. **deprecated** - The function is deprecated. **archived** - The function is archived. **inactive** - The function is inactive. **hibernated** - The function is hibernated.
Known values: active, unpublished, deprecated, archived, inactive, hibernated

Referenced models: Function — functions get Function — response body — functions functions item created by, Function — functions get Function — response body — functions functions item modified by, Function — functions get Function — response body — functions functions item arguments null item, Function — functions get Function — response body — functions functions item Tag item

Function — functions get Function — response body — functions functions item created by
FieldTypePresenceDescription and constraints
$objectRootRepresents the user who created the resource, including the user's name and ID.
Additional keys: not allowed
idstringRequired within parentThe unique ID of the user who created the function.
Format: int64
namestringRequired within parentDisplay name of the user who created the function.
Maximum length: 100
Function — functions get Function — response body — functions functions item modified by
FieldTypePresenceDescription and constraints
$objectRootRepresents the user who last modified the resource, including the user's display name and unique identifier.
Additional keys: not allowed
idstringRequired within parentRepresents the unique identifier of the user who last modified the resource.
Format: int64
namestringRequired within parentRepresents the display name of the user who last modified the resource.
Maximum length: 100
Function — functions get Function — response body — functions functions item arguments null item
FieldTypePresenceDescription and constraints
$objectRootRepresents a function argument definition, including the argument name and its expected data type.
Additional keys: not allowed
namestringRequired within parentThe name of the function argument.
Maximum length: 100
typestringRequired within parentThe data type of the function argument.
Maximum length: 100
Function — functions get Function — response body — functions functions item Tag item
FieldTypePresenceDescription and constraints
$objectRootRepresents a tag associated with a resource, including the tag name, unique identifier, and color code.
Additional keys: not allowed
color_codestringRequired within parentThe hex color code assigned to the tag for visual identification.
Format: color
idstringRequired within parentUnique identifier of the tag.
Format: int64
namestringRequired within parentThe display name of the tag.
Maximum length: 100

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