Zoho: List Cadences
Zoho cadences.getCadences: arguments, response, policy and SDK examples.
← Cadences operations · Get started
Operation zoho.getcadences
Provider route: GET /crm/v8/settings/automation/cadences. 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["cadences"]["getCadences"]>[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.cadences.getCadences(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.cadences.get_cadences(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: 255 |
query.name | string | Optional | Maximum length: 100 |
query.active | boolean | Optional | |
query.fields | string | Optional | One of: name |
query.page | integer | Optional | Format: int32 |
query.per_page | integer | Optional | Format: int32 |
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 |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents the successful response for the Cadence list request. Additional keys: not allowed |
$ (anyOf 1).cadences | array | Required within parent | Represents the list of Cadences retrieved from Zoho CRM. Maximum items: 400 |
$ (anyOf 1).cadences[] | object | Each item | Each object represents a Cadence configured in Zoho CRM, including its schedule, execution details, and status. Additional keys: not allowed |
$ (anyOf 1).cadences[].active | boolean | Optional | Represents whether the Cadence is currently active. Possible values: true, false. |
$ (anyOf 1).cadences[].created_by | Model | Optional | Expand Get Cadence analytics — response body — cadences item created by |
$ (anyOf 1).cadences[].created_time | string | Optional | Represents the creation date and time of the Cadence, in ISO 8601 format. Format: date-time |
$ (anyOf 1).cadences[].custom_view | Model | Optional | Expand Get a Cadence — response body — cadences cadences item custom view |
$ (anyOf 1).cadences[].description | string | Optional | Represents the description text of a Cadence. Maximum length: 500 |
$ (anyOf 1).cadences[].execution_details | JSON | Optional | |
$ (anyOf 1).cadences[].execution_details (anyOf 1) | object | Alternative | Represents the execution configuration for the Cadence, including the schedule type, end date, and unenrollment settings. Additional keys: not allowed |
$ (anyOf 1).cadences[].execution_details (anyOf 1).automatic_unenroll | boolean | Optional | Indicates whether records enrolled in the Cadence are automatically unenrolled when the scheduled execution period ends. Possible values: true, false. |
$ (anyOf 1).cadences[].execution_details (anyOf 1).end_date | string | Optional | Represents the date on which the Cadence execution ends. Maximum length: 50 |
$ (anyOf 1).cadences[].execution_details (anyOf 1).execute_every | Model | Optional | Expand Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties execute every |
$ (anyOf 1).cadences[].execution_details (anyOf 1).type | JSON | Optional | |
$ (anyOf 1).cadences[].execution_details (anyOf 1).type (anyOf 1) | string | Alternative | Represents the execution schedule type for the Cadence. Maximum length: 255 |
$ (anyOf 1).cadences[].execution_details (anyOf 1).type (anyOf 2) | null | Alternative | Represents the execution schedule type for the Cadence. Maximum length: 255 |
$ (anyOf 1).cadences[].execution_details (anyOf 1).unenroll_properties | Model | Optional | Expand List Cadences — response body — cadences, info cadences item execution details automatic unenroll, end date, execute every, type, unenroll properties unenroll properties |
$ (anyOf 1).cadences[].execution_details (anyOf 2) | null | Alternative | Represents the execution configuration for the Cadence, including the schedule type, end date, and unenrollment settings. Additional keys: not allowed |
$ (anyOf 1).cadences[].execution_details (anyOf 2).automatic_unenroll | boolean | Optional | Indicates whether records enrolled in the Cadence are automatically unenrolled when the scheduled execution period ends. Possible values: true, false. |
$ (anyOf 1).cadences[].execution_details (anyOf 2).end_date | string | Optional | Represents the date on which the Cadence execution ends. Maximum length: 50 |
$ (anyOf 1).cadences[].execution_details (anyOf 2).execute_every | Model | Optional | Expand Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties execute every |
$ (anyOf 1).cadences[].execution_details (anyOf 2).type | JSON | Optional | |
$ (anyOf 1).cadences[].execution_details (anyOf 2).type (anyOf 1) | string | Alternative | Represents the execution schedule type for the Cadence. Maximum length: 255 |
$ (anyOf 1).cadences[].execution_details (anyOf 2).type (anyOf 2) | null | Alternative | Represents the execution schedule type for the Cadence. Maximum length: 255 |
$ (anyOf 1).cadences[].execution_details (anyOf 2).unenroll_properties | Model | Optional | Expand List Cadences — response body — cadences, info cadences item execution details automatic unenroll, end date, execute every, type, unenroll properties unenroll properties |
$ (anyOf 1).cadences[].id | string | Required within parent | Represents the unique identifier of a Cadence. Maximum length: 255 |
$ (anyOf 1).cadences[].modified_by | Model | Optional | Expand Get a Cadence — response body — cadences cadences item modified by |
$ (anyOf 1).cadences[].modified_time | JSON | Optional | |
$ (anyOf 1).cadences[].modified_time (anyOf 1) | string | Alternative | Represents the date and time when the Cadence was last modified, in ISO 8601 format. Format: date-time |
$ (anyOf 1).cadences[].modified_time (anyOf 2) | null | Alternative | Represents the date and time when the Cadence was last modified, in ISO 8601 format. Format: date-time |
$ (anyOf 1).cadences[].module | Model | Optional | Expand Get Cadence analytics — response body — cadences item module |
$ (anyOf 1).cadences[].name | string | Required within parent | Represents the name of a Cadence. Maximum length: 100 |
$ (anyOf 1).cadences[].published | boolean | Optional | Represents whether the Cadence has been published. Possible values: true, false. |
$ (anyOf 1).cadences[].status | string | Optional | Cadence lifecycle status. Possible values draft = not yet published; active = published and enrolling records; inactive = published but currently deactivated. Known values: active, inactive, draft |
$ (anyOf 1).cadences[].summary | Model | Optional | Expand Get a Cadence — response body — cadences cadences item summary |
$ (anyOf 1).cadences[].type | string | Optional | Indicates the enrollment type of the Cadence. Possible values: Custom view, Manual enrollment. Known values: Custom view, Manual enrollment |
$ (anyOf 1).info | object | Required within parent | Represents the pagination details for the list of Cadences. Additional keys: not allowed |
$ (anyOf 1).info.count | JSON | Optional | |
$ (anyOf 1).info.count (anyOf 1) | integer | Alternative | Represents the total number of Cadences retrieved in the current response. Format: int32 |
$ (anyOf 1).info.count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).info.more_records | boolean | Optional | Represents whether additional Cadences are available beyond the current page. |
$ (anyOf 1).info.page | JSON | Optional | |
$ (anyOf 1).info.page (anyOf 1) | integer | Alternative | Represents the current page number of the paginated response. Format: int32 |
$ (anyOf 1).info.page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).info.per_page | JSON | Optional | |
$ (anyOf 1).info.per_page (anyOf 1) | integer | Alternative | Represents the number of Cadences returned per page. Format: int32 |
$ (anyOf 1).info.per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2) | null | Alternative |
Referenced models: Get Cadence analytics — response body — cadences item created by, Get Cadence analytics — response body — cadences item module, Get a Cadence — response body — cadences cadences item custom view, Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties execute every, Get a Cadence — response body — cadences cadences item summary, Get a Cadence — response body — cadences cadences item modified by, List Cadences — response body — cadences, info cadences item execution details automatic unenroll, end date, execute every, type, unenroll properties unenroll properties
Schemas
Section titled “Schemas”Get Cadence analytics — response body — cadences item created by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the identifier and name of the user who created the record. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the user who created the record. Maximum length: 255 |
name | string | Optional | Represents the full name of the user who created the record. Maximum length: 255 |
Get Cadence analytics — response body — cadences item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the API name and identifier of a CRM module. Additional keys: not allowed |
api_name | string | Optional | Represents the API name of the CRM module. Maximum length: 255 |
id | string | Optional | Represents the unique identifier of the CRM module. Format: int64 Maximum length: 255 |
Get a Cadence — response body — cadences cadences item custom view
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents the identifier and name of a Custom View. Additional keys: not allowed |
$ (anyOf 1).id | string | Optional | Represents the unique identifier of the Custom View. Maximum length: 255 |
$ (anyOf 1).name | string | Optional | Represents the name of the Custom View. Maximum length: 255 |
$ (anyOf 2) | null | Alternative | Represents the identifier and name of a Custom View. Additional keys: not allowed |
$ (anyOf 2).id | string | Optional | Represents the unique identifier of the Custom View. Maximum length: 255 |
$ (anyOf 2).name | string | Optional | Represents the name of the Custom View. Maximum length: 255 |
Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties execute every
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents the recurring execution interval for a Cadence, specifying the frequency period and numeric value. Additional keys: not allowed |
$ (anyOf 1).period | string | Required within parent | Represents the frequency interval for recurring Cadence execution. Possible values: immediately - Execute immediately after each enrollment trigger. hours - Execute at the specified number of hours interval. days - Execute at the specified number of days interval. weeks - Execute at the specified number of weeks interval. Known values: immediately, hours, days, weeks |
$ (anyOf 1).unit | JSON | Optional | |
$ (anyOf 1).unit (anyOf 1) | integer | Alternative | Represents the numeric value of the execution interval, expressed in the specified period unit. Format: int32 Maximum: 99 Minimum: 1 |
$ (anyOf 1).unit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2) | null | Alternative | Represents the recurring execution interval for a Cadence, specifying the frequency period and numeric value. Additional keys: not allowed |
$ (anyOf 2).period | string | Required within parent | Represents the frequency interval for recurring Cadence execution. Possible values: immediately - Execute immediately after each enrollment trigger. hours - Execute at the specified number of hours interval. days - Execute at the specified number of days interval. weeks - Execute at the specified number of weeks interval. Known values: immediately, hours, days, weeks |
$ (anyOf 2).unit | JSON | Optional | |
$ (anyOf 2).unit (anyOf 1) | integer | Alternative | Represents the numeric value of the execution interval, expressed in the specified period unit. Format: int32 Maximum: 99 Minimum: 1 |
$ (anyOf 2).unit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get a Cadence — response body — cadences cadences item summary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a summary of follow-up action counts in a Cadence, broken down by action type. Additional keys: not allowed |
call_follow_up_count | JSON | Optional | |
call_follow_up_count (anyOf 1) | integer | Alternative | Represents the number of scheduled call follow-up actions in the Cadence. Format: int32 |
call_follow_up_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
email_follow_up_count | JSON | Optional | |
email_follow_up_count (anyOf 1) | integer | Alternative | Represents the number of email notification follow-up actions in the Cadence. Format: int32 |
email_follow_up_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
task_follow_up_count | JSON | Optional | |
task_follow_up_count (anyOf 1) | integer | Alternative | Represents the number of task follow-up actions in the Cadence. Format: int32 |
task_follow_up_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
whatsapp_follow_up_count | JSON | Optional | |
whatsapp_follow_up_count (anyOf 1) | integer | Alternative | Represents the number of WhatsApp message follow-up actions in the Cadence. Format: int32 |
whatsapp_follow_up_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get a Cadence — response body — cadences cadences item modified by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents the identifier and name of the user who last modified the record. Additional keys: not allowed |
$ (anyOf 1).id | string | Optional | Represents the unique identifier of the user who last modified the record. Maximum length: 255 |
$ (anyOf 1).name | string | Optional | Represents the full name of the user who last modified the record. Maximum length: 255 |
$ (anyOf 2) | null | Alternative | Represents the identifier and name of the user who last modified the record. Additional keys: not allowed |
$ (anyOf 2).id | string | Optional | Represents the unique identifier of the user who last modified the record. Maximum length: 255 |
$ (anyOf 2).name | string | Optional | Represents the full name of the user who last modified the record. Maximum length: 255 |
List Cadences — response body — cadences, info cadences item execution details automatic unenroll, end date, execute every, type, unenroll properties unenroll properties
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the automatic unenrollment configuration applied when records are removed from the Cadence. Additional keys: not allowed |
end_date | string | Optional | Represents the date on which the automatic unenrollment of records from the Cadence takes effect. Maximum length: 50 |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | Represents the type of automatic unenrollment applied to the Cadence. Maximum length: 255 |
type (anyOf 2) | null | Alternative | Represents the type of automatic unenrollment applied to the Cadence. Maximum length: 255 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getcadences. Catalog operation: getCadences. 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]