Skip to content

Zoho: Functions

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

← Functions operations · Get started

Operation zoho.getfunctions

Provider route: GET /crm/v8/settings/functions. 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"]["getFunctions"]>[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.getFunctions(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_functions(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.pageintegerOptionalFormat: int32
Minimum: 1
query.per_pageintegerOptionalFormat: int32
Minimum: 1
query.page_tokenstringOptionalMaximum length: 1000

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 Functions — response body — functions, info
$ (anyOf 2)nullAlternative

Referenced models: Functions — response body — functions, info

4 more schemas are linked from the tables above, on the schema pages.

Functions — response body — functions, info
FieldTypePresenceDescription and constraints
$objectRootRepresents the successful response body containing a list of function metadata objects and pagination information.
Additional keys: not allowed
functionsarrayRequired within parentRepresents the list of function metadata objects returned in the response.
Maximum items: 200
functions[]ModelEach itemExpand Function — functions get Function — response body — functions functions item
infoModelRequired within parentExpand Functions — response body — functions, info info

Referenced models: Functions — response body — functions, info info, Function — functions get Function — response body — functions functions item

Functions — response body — functions, info info
FieldTypePresenceDescription and constraints
$objectRootPagination metadata returned with list responses, including page number, per-page count, total record count, sort details, and page tokens for cursor-based navigation.
Additional keys: not allowed
countJSONRequired within parent
count (anyOf 1)integerAlternativeThe total number of records returned in the current response.
Format: int32
count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_recordsbooleanRequired within parentIndicates whether additional records are available beyond the current page. Possible values: **true** - More records exist beyond the current page. **false** - No additional records exist beyond the current page.
next_page_tokenJSONRequired within parent
next_page_token (anyOf 1)stringAlternativeThe token used to retrieve the next page of results. Present when additional records are available beyond the current page.
Maximum length: 1000
next_page_token (anyOf 2)nullAlternativeThe token used to retrieve the next page of results. Present when additional records are available beyond the current page.
Maximum length: 1000
pageJSONRequired within parent
page (anyOf 1)integerAlternativeThe current page number in offset-based pagination.
Format: int32
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
page_token_expiryJSONRequired within parent
page_token_expiry (anyOf 1)stringAlternativeRepresents the expiration timestamp of the page tokens in ISO 8601 format.
Format: date-time
page_token_expiry (anyOf 2)nullAlternativeRepresents the expiration timestamp of the page tokens in ISO 8601 format.
Format: date-time
per_pageJSONRequired within parent
per_page (anyOf 1)integerAlternativeThe maximum number of records returned per page in the response.
Format: int32
per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
previous_page_tokenJSONRequired within parent
previous_page_token (anyOf 1)stringAlternativeThe token used to retrieve the previous page of results. Present when a previous page exists.
Maximum length: 1000
previous_page_token (anyOf 2)nullAlternativeThe token used to retrieve the previous page of results. Present when a previous page exists.
Maximum length: 1000
sort_bystringRequired within parentThe field used to sort the results. Possible values: **id** - Sorts results by record ID.
Known values: id
sort_orderstringRequired within parentRepresents the direction in which results are sorted. Possible values: **asc** - Ascending order. **desc** - Descending order.
Known values: asc, desc
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

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