Zoho: Get a Cadence

← Cadences operations · Get started

Operation zoho.getcadence

Provider route: GET /crm/v8/settings/automation/cadences/{id}. Alter supplies the connection’s credentials and routing.

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"]["getCadence"]>[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.getCadence(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.cadences.get_cadence(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Maximum length: 255

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)	Model	Alternative	Expand Get a Cadence — response body — cadences
$ (anyOf 2)	null	Alternative

Referenced models: Get a Cadence — response body — cadences

Schemas

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

Get a Cadence — response body — cadences

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response containing the details of a specific Cadence retrieved by its identifier. Additional keys: not allowed
cadences	array	Optional	Represents the list of Cadences with their full details. Maximum items: 1
cadences[]	object	Each item	Represents the detailed configuration and metadata for a single Cadence. Additional keys: not allowed
cadences[].created_by	Model	Optional	Expand Get Cadence analytics — response body — cadences item created by
cadences[].created_time	string	Optional	Represents the creation date and time of the Cadence, in ISO 8601 format. Format: date-time
cadences[].custom_view	Model	Optional	Expand Get a Cadence — response body — cadences cadences item custom view
cadences[].description	string	Optional	Represents the description text of a Cadence. Maximum length: 500
cadences[].draft_cadence	object	Optional	Represents the draft version of the Cadence, if one exists. Additional keys: not allowed
cadences[].draft_cadence.id	string	Optional	Represents the unique identifier of a Cadence. Maximum length: 255
cadences[].draft_cadence.name	string	Optional	Represents the name of a Cadence. Maximum length: 100
cadences[].execution_details	JSON	Optional
cadences[].execution_details (anyOf 1)	object	Alternative	Represents the execution frequency and unenrollment configuration for the Cadence. Additional keys: not allowed
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
cadences[].execution_details (anyOf 1).unenroll_properties	JSON	Optional
cadences[].execution_details (anyOf 1).unenroll_properties (anyOf 1)	array	Alternative	Represents the list of conditions under which records are automatically unenrolled from the Cadence. Maximum items: 50
cadences[].execution_details (anyOf 1).unenroll_properties (anyOf 1)[]	Model	Each item	Expand Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties unenroll properties null item
cadences[].execution_details (anyOf 1).unenroll_properties (anyOf 2)	null	Alternative	Represents the list of conditions under which records are automatically unenrolled from the Cadence. Maximum items: 50
cadences[].execution_details (anyOf 1).unenroll_properties (anyOf 2)[]	Model	Each item	Expand Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties unenroll properties null item
cadences[].execution_details (anyOf 2)	null	Alternative	Represents the execution frequency and unenrollment configuration for the Cadence. Additional keys: not allowed
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
cadences[].execution_details (anyOf 2).unenroll_properties	JSON	Optional
cadences[].execution_details (anyOf 2).unenroll_properties (anyOf 1)	array	Alternative	Represents the list of conditions under which records are automatically unenrolled from the Cadence. Maximum items: 50
cadences[].execution_details (anyOf 2).unenroll_properties (anyOf 1)[]	Model	Each item	Expand Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties unenroll properties null item
cadences[].execution_details (anyOf 2).unenroll_properties (anyOf 2)	null	Alternative	Represents the list of conditions under which records are automatically unenrolled from the Cadence. Maximum items: 50
cadences[].execution_details (anyOf 2).unenroll_properties (anyOf 2)[]	Model	Each item	Expand Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties unenroll properties null item
cadences[].follow_ups	array	Optional	Represents the list of follow-up steps configured in the Cadence. Maximum items: 200
cadences[].follow_ups[]	object	Each item	Represents a single follow-up step in the Cadence. Additional keys: not allowed
cadences[].follow_ups[].action	object	Required within parent	Represents the action configured for the follow-up step. Additional keys: allowed
cadences[].follow_ups[].execute_after	object	Optional	Represents the wait period before this follow-up step executes. Additional keys: not allowed
cadences[].follow_ups[].execute_after.id	string	Optional	Represents the unique identifier for the execute-after configuration. Maximum length: 255
cadences[].follow_ups[].execute_after.period	string	Optional	Represents the numeric duration of the wait period. Maximum length: 255
cadences[].follow_ups[].execute_after.unit	JSON	Optional
cadences[].follow_ups[].execute_after.unit (anyOf 1)	integer	Alternative	Represents the time unit for the wait period. Format: int32
cadences[].follow_ups[].execute_after.unit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cadences[].follow_ups[].id	string	Required within parent	Represents the unique identifier of the follow-up step. Maximum length: 255
cadences[].follow_ups[].parent_follow_up	JSON	Required within parent
cadences[].follow_ups[].parent_follow_up (anyOf 1)	object	Alternative	Represents the parent follow-up step that this step branches from.
cadences[].follow_ups[].parent_follow_up (anyOf 1).id	string	Optional	Represents the unique identifier of the parent follow-up step. Maximum length: 255
cadences[].follow_ups[].parent_follow_up (anyOf 1).type	string	Optional	Represents the branch type of the parent follow-up connection. Maximum length: 255
cadences[].follow_ups[].parent_follow_up (anyOf 2)	null	Alternative	Represents the parent follow-up step that this step branches from.
cadences[].follow_ups[].parent_follow_up (anyOf 2).id	string	Optional	Represents the unique identifier of the parent follow-up step. Maximum length: 255
cadences[].follow_ups[].parent_follow_up (anyOf 2).type	string	Optional	Represents the branch type of the parent follow-up connection. Maximum length: 255
cadences[].follow_ups[].triggers	JSON	Optional
cadences[].follow_ups[].triggers (anyOf 1)	array	Alternative	Represents the list of trigger conditions for the follow-up step. Maximum items: 25
cadences[].follow_ups[].triggers (anyOf 1)[]	string	Each item	Represents a single trigger condition for the follow-up step. Maximum length: 255
cadences[].follow_ups[].triggers (anyOf 2)	null	Alternative	Represents the list of trigger conditions for the follow-up step. Maximum items: 25
cadences[].follow_ups[].triggers (anyOf 2)[]	string	Each item	Represents a single trigger condition for the follow-up step. Maximum length: 255
cadences[].id	string	Required within parent	Represents the unique identifier of a Cadence. Maximum length: 255
cadences[].modified_by	Model	Optional	Expand Get a Cadence — response body — cadences cadences item modified by
cadences[].modified_time	JSON	Optional
cadences[].modified_time (anyOf 1)	string	Alternative	Represents the date and time when the Cadence was last modified. Maximum length: 255
cadences[].modified_time (anyOf 2)	null	Alternative	Represents the date and time when the Cadence was last modified. Maximum length: 255
cadences[].module	Model	Required within parent	Expand Get Cadence analytics — response body — cadences item module
cadences[].name	string	Required within parent	Represents the name of a Cadence. Maximum length: 100
cadences[].parent_cadence	object	Optional	Represents the original Cadence from which this Cadence was cloned. Additional keys: not allowed
cadences[].parent_cadence.id	string	Optional	Represents the unique identifier of a Cadence. Maximum length: 255
cadences[].parent_cadence.name	string	Optional	Represents the name of a Cadence. Maximum length: 100
cadences[].status	string	Required within parent	Cadence lifecycle status. draft = not yet published; active = published and enrolling records; inactive = published but currently deactivated. Maximum length: 255
cadences[].summary	Model	Optional	Expand Get a Cadence — response body — cadences cadences item summary
cadences[].type	string	Required within parent	Represents the enrollment type of a Cadence, indicating how records are enrolled. Known values: custom_view, manual_enrollment Maximum length: 255

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, Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties unenroll properties null item

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

Policy, approvals and errors

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