Zoho: List Email Notifications
Zoho emailNotifications.getEmailNotifications: arguments, response, policy and SDK examples.
← Email notifications operations · Get started
Operation zoho.getemailnotifications
Provider route: GET /crm/v8/settings/automation/email_notifications. 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["emailNotifications"]["getEmailNotifications"]>[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.emailNotifications.getEmailNotifications(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.email_notifications.get_email_notifications(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.filters | string | Optional | Maximum length: 10000 |
query.module | string | Optional | Maximum length: 255 |
query.related_module | string | Optional | Maximum length: 255 |
query.feature_type | string | Optional | Automation feature type filter. When omitted, returns all email notifications regardless of feature type. ‘workflow’ - workflow rules. ‘approval_process’ - approval workflows. ‘blueprint’ / ‘blueprint_transition’ / ‘blueprint_state’ - blueprint stages. ‘review_process’ - review processes. ‘orchestration’ - orchestration flows. ‘assignment_rules’ - assignment rules. ‘kiosk’ - kiosk actions. ‘pathfinder’ - pathfinder. ‘connected_workflows’ - connected workflows. ‘commandcenter_service’ - command center. ‘cadences’ - cadence actions. One of: workflow, approval_process, blueprint, blueprint_transition, blueprint_state, review_process, orchestration, assignment_rules, kiosk, pathfinder, connected_workflows, commandcenter_service, cadences Maximum length: 255 |
query.page | integer | Optional | Default: 1 Format: int32 Minimum: 1 |
query.per_page | integer | Optional | Default: 200 Format: int32 Maximum: 200 Minimum: 1 |
query.sort_by | string | Optional | One of: modified_time |
query.sort_order | string | Optional | One of: desc, asc |
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 List Email Notifications — response body |
Referenced models: List Email Notifications — response body
Schemas
Section titled “Schemas”31 more schemas are linked from the tables above, on the schema pages.
List Email Notifications — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the successful retrieval response for a page of email notification definitions, including pagination information. Additional keys: not allowed |
email_notifications | array | Optional | Represents the list of email notification definitions returned for the current page. Maximum items: 200 |
email_notifications[] | Model | Each item | Expand List Email Notifications — response body — email notifications item |
info | Model | Optional | Expand List Email Notifications — response body — info |
Referenced models: List Email Notifications — response body — email notifications item, List Email Notifications — response body — info
List Email Notifications — response body — email notifications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a summary of an email notification action, including its template, sender and reply-to configuration, recipient collections, primary module context, audit metadata, and association status. Additional keys: not allowed |
associated | boolean | Optional | Indicates whether this notification action is currently associated with an automation rule or process. Possible values: true - The notification action is linked to one or more active automation rules or processes. false - The notification action is not linked to any automation rule or process. |
bulk_email | boolean | Optional | Indicates whether the notification is sent as a single mass email. Possible values: true - The notification is sent as a mass email, and CC and BCC recipients are allowed. false - The notification is sent as individual emails, and CC and BCC recipients are not included. |
created_by | Model | Optional | Expand List Email Notifications — response body — email notifications item created by User who created this notification action. |
created_time | string | Optional | Represents the date and time when this notification action was created. Format: date-time Maximum length: 255 |
deletable | boolean | Optional | Indicates whether the current user can delete this notification action. Possible values: true - The current user has permission to delete this notification action. false - The current user does not have permission to delete this notification action. |
editable | boolean | Optional | Indicates whether the current user can edit this notification action. Possible values: true - The current user has permission to edit this notification action. false - The current user does not have permission to edit this notification action. |
feature_type | Model | Optional | Expand List Email Notifications — response body — email notifications item feature type Automation feature where this action is used. |
from_address | Model | Optional | Expand List Email Notifications — response body — email notifications item from address Sender configuration used to send the notification email. |
id | string | Optional | Represents the unique identifier of the email notification action. Maximum length: 20 |
lock_status | Model | Optional | Expand List Email Notifications — response body — email notifications item lock status Indicates whether this notification action is locked for edit/delete. |
modified_by | Model | Optional | Expand List Email Notifications — response body — email notifications item modified by User who last modified this notification action. |
modified_time | string | Optional | Represents the date and time when this notification action was last modified. Format: date-time Maximum length: 255 |
module | Model | Required within parent | Expand List Email Notifications — response body — email notifications item module Primary module on which this notification action is configured. |
name | string | Required within parent | Represents the display name of the email notification action. The special characters ~`#%^&*()+={}[]|;"<>\ are not allowed. Maximum length: 255 Pattern: ^[^~`#%^&*()+={}\[\]|;"<>\\]+$ |
recipient_count | string | Optional | Represents the total number of recipients configured for this email notification action. Maximum length: 255 |
recipients | Model | Optional | Expand List Email Notifications — response body — email notifications item recipients Recipient configuration containing to/cc/bcc collections for this notification action. |
related_module | Model | Optional | Expand List Email Notifications — response body — email notifications item related module Related module context when the automation is configured on related records; null when not applicable. |
reply_to_address | Model | Optional | Expand List Email Notifications — response body — email notifications item reply to address Reply-to configuration used when recipients reply to the notification email. |
source | string | Optional | Represents the source application from which this notification action is configured, for example, crm. Maximum length: 255 |
template | Model | Required within parent | Expand List Email Notifications — response body — email notifications item template Email template used by this notification (template id and name). |
Referenced models: List Email Notifications — response body — email notifications item created by, List Email Notifications — response body — email notifications item lock status, List Email Notifications — response body — email notifications item modified by, List Email Notifications — response body — email notifications item module, List Email Notifications — response body — email notifications item template, List Email Notifications — response body — email notifications item feature type, List Email Notifications — response body — email notifications item related module, List Email Notifications — response body — email notifications item recipients, List Email Notifications — response body — email notifications item from address, List Email Notifications — response body — email notifications item reply to address
List Email Notifications — response body — info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the pagination state for a collection response, including the current page number, the number of records per page, the total records returned, and whether additional records are available. Additional keys: not allowed |
count | JSON | Optional | |
count (anyOf 1) | integer | Alternative | Represents the number of records returned in the current response page. Format: int32 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_limit | JSON | Optional | |
max_limit (anyOf 1) | integer | Alternative | Represents the maximum number of records that can be returned per page for this collection. Format: int32 |
max_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
more_records | boolean | Optional | Indicates 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. |
page | JSON | Optional | |
page (anyOf 1) | integer | Alternative | Represents the current page number in the paginated result set, reflecting the requested page value. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
per_page | JSON | Optional | |
per_page (anyOf 1) | integer | Alternative | Represents the number of records requested per page. Format: int32 |
per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List Email Notifications — response body — email notifications item created by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the creator of a resource, including their name and unique identifier. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the user who created the resource. Maximum length: 255 |
name | string | Optional | Represents the name of the user who created the resource. Maximum length: 255 |
List Email Notifications — response body — email notifications item lock status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Indicates whether a particular component is locked, affecting its editability and usability. Additional keys: not allowed |
locked | boolean | Optional | Indicates whether the component is locked. Possible values: true - The component is locked and cannot be edited or used. false - The component is not locked and remains editable and usable. |
List Email Notifications — response body — email notifications item modified by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the last person who modified a resource, including their name and unique identifier. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the user who last modified the resource. Maximum length: 255 |
name | string | Optional | Represents the full name of the user who last modified the resource. Maximum length: 255 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getemailnotifications. Catalog operation: getEmailNotifications. 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.