Zoho: Get Cadence records count

← Cadences operations · Get started

Operation zoho.listcadencesrecordscount

Provider route: GET /crm/v8/settings/automation/cadences/actions/records_count. 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"]["listCadencesRecordsCount"]>[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.listCadencesRecordsCount(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.list_cadences_records_count(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.ids	string	Optional	Comma-separated cadence ids Maximum length: 2000

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 containing a list of Cadence record count entries. Additional keys: not allowed
$ (anyOf 1).cadences_records_count	array	Required within parent	Represents the list of Cadence record count entries in the success response. Maximum items: 100
$ (anyOf 1).cadences_records_count[]	Model	Each item	Expand Get Cadence records count — response body — cadences records count cadences records count item
$ (anyOf 2)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count

Referenced models: Get Cadence records count — response body — cadences records count cadences records count item, Get Cadence records count — response body — cadences records count

Schemas

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

Get Cadence records count — response body — cadences records count cadences records count item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the record count data for a Cadence, including the Cadence identifier and the number of enrolled records. Additional keys: not allowed
cadences	object	Optional	Represents the identifier and name details of the Cadence. Additional keys: not allowed
cadences.id	string	Optional	Represents the unique identifier of a Cadence. Maximum length: 255
cadences.name	string	Optional	Represents the name of a Cadence. Maximum length: 100
count	JSON	Optional
count (anyOf 1)	integer	Alternative	Represents the number of records currently enrolled in the Cadence. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Cadence records count — response body — cadences records count

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response containing the count of records enrolled in each Cadence. Additional keys: not allowed
cadences_records_count	array	Optional	Represents the list of Cadences with their corresponding record counts. Maximum items: 100
cadences_records_count[]	JSON	Each item	Represents the record count details for a single Cadence.
cadences_records_count[] (anyOf 1)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item
cadences_records_count[] (anyOf 2)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error

Referenced models: Get Cadence records count — response body — cadences records count cadences records count item status error, Get Cadence records count — response body — cadences records count cadences records count item

Get Cadence records count — response body — cadences records count cadences records count item status error details ambiguity due to

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details for ambiguity, listing the fields that caused the ambiguity. Additional keys: not allowed
ambiguity_due_to	array	Required within parent	Represents the list of fields that caused the ambiguity during processing. Maximum items: 100
ambiguity_due_to[]	object	Each item	Represents a field that contributed to the ambiguity, identified by its API name and JSON path. Additional keys: not allowed
ambiguity_due_to[].api_name	string	Optional	Represents the API name of the field that caused the ambiguity. Maximum length: 255
ambiguity_due_to[].json_path	string	Optional	Represents the JSON path of the field that caused the ambiguity. Maximum length: 255

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, exists in, json path

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when an API name already exists at the specified JSON path. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field that already exists in the specified JSON path. Maximum length: 255
exists_in	object	Required within parent	Represents the location where the API name already exists, identified by its API name and JSON path. Additional keys: not allowed
exists_in.api_name	string	Optional	Represents the API name at the existing location. Maximum length: 255
exists_in.json_path	string	Optional	Represents the JSON path of the existing field location. Maximum length: 500
json_path	string	Required within parent	Represents the JSON path of the duplicate field in the request payload. Maximum length: 500

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, id, json path

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a field contains an invalid identifier. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field with invalid data. Maximum length: 255
id	string	Required within parent	Represents the identifier of the invalid value provided. Maximum length: 255
json_path	string	Required within parent	Represents the JSON path of the field with invalid data. Maximum length: 500

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, json path, param name, supported values

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a field contains an invalid value, listing the supported values. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field with invalid data. Maximum length: 255
json_path	string	Required within parent	Represents the JSON path of the field with invalid data. Maximum length: 500
param_name	string	Optional	Represents the parameter name of the field with invalid data. Maximum length: 255
supported_values	array	Required within parent	Represents the list of supported values for the field. Maximum items: 25
supported_values[]	string	Each item	Represents a supported value for the field. Maximum length: 500

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, dependee, json path, param name

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a required dependency field is missing from the request. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the field with the missing dependency. Maximum length: 255
dependee	object	Required within parent	Represents the dependee field that is required but missing from the request. Additional keys: not allowed
dependee.api_name	string	Optional	Represents the API name of the dependee field. Maximum length: 255
dependee.json_path	string	Optional	Represents the JSON path of the dependee field. Maximum length: 500
dependee.param_name	string	Optional	Represents the parameter name of the dependee field. Maximum length: 255
json_path	string	Optional	Represents the JSON path of the field with the missing dependency. Maximum length: 500
param_name	string	Optional	Represents the parameter name associated with the field. Maximum length: 255

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, dependee, expected data type, json path, param name, supported values

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a dependent field value does not match the expected values based on the parent field. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the field with the dependency mismatch. Maximum length: 255
dependee	object	Required within parent	Represents the dependee field associated with the mismatch. Additional keys: not allowed
dependee.api_name	string	Required within parent	Represents the API name of the dependee field. Maximum length: 255
dependee.json_path	string	Required within parent	Represents the JSON path of the dependee field. Maximum length: 500
expected_data_type	string	Optional	Represents the data type the server expected for the dependent field based on the parent field's value. Maximum length: 255
json_path	string	Optional	Represents the JSON path of the field with the dependency mismatch. Maximum length: 500
param_name	string	Optional	Represents the parameter name associated with the field. Maximum length: 255
supported_values	array	Optional	Represents the list of supported values for the dependee field. Maximum items: 25
supported_values[]	string	Each item	Represents a supported value for the dependee field. Maximum length: 500
$ (anyOf 1)	JSON	Alternative	Represents the variant of DependentMismatchDetails in which the allowed values for the dependent field are conveyed through the supported_values list.
$ (anyOf 1).supported_values	array	Required within parent	Represents the list of allowed values for the dependent field given the parent field's current value. Maximum items: 25
$ (anyOf 1).supported_values[]	string	Each item	Represents an allowed value for the dependent field. Maximum length: 500
$ (anyOf 2)	JSON	Alternative	Represents the variant of DependentMismatchDetails in which the expected data type for the dependent field is conveyed through expected_data_type.
$ (anyOf 2).expected_data_type	string	Required within parent	Represents the data type expected for the dependent field given the parent field's current value. Maximum length: 255

Get Cadence records count — response body — cadences records count cadences records count item status error details permissions

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when the request fails due to missing permissions. Additional keys: not allowed
permissions	array	Required within parent	Represents the list of required permissions that are missing. Maximum items: 25
permissions[]	string	Each item	Represents the name of a required permission. Maximum length: 255

Get Cadence records count — response body — cadences records count cadences records count item status error details object

Field	Type	Presence	Description and constraints
$	object	Root	Represents an empty error details object with no additional information. Additional keys: not allowed

Policy, approvals and errors

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

Official provider source