> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Zoho CRM: README
> GET - Get all cadences. Zoho CRM Cadences Get Cadences reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.
GET - Get all cadences.
Tool ID: `zoho_crm_cadences_get_cadences`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'zoho_crm_cadences_get_cadences',
{
"module": "example",
"name": "Example",
"active": true
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_cadences_get_cadences --input '{
"module": "example",
"name": "Example",
"active": true
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"cadences": [
{
"summary": {
"whatsapp_follow_up_count": 123,
"task_follow_up_count": 123,
"call_follow_up_count": 123
},
"description": "Example description",
"created_time": "2026-01-15T12:00:00Z"
}
],
"info": {
"per_page": 123,
"count": 123,
"page": 123
}
}
}
```
Use `deepline tools get zoho_crm_cadences_get_cadences --json` for the latest machine-readable contract.
## Input reference
Get all cadences
| Name | Type | Required | Default | Details |
| ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------- |
| `payload.module` | `string` | No | — | Cadence supported modules like Leads, Contacts, Accounts, Deals, Quotes, Vendors or custom module Maximum length: 255. |
| `payload.name` | `string` | No | — | Filters by cadence name Maximum length: 100. |
| `payload.active` | `boolean` | No | — | Filters by cadence active status. Use true or false |
| `payload.fields` | `"name"` | No | — | Filters by fields. Use name Allowed: `name`. |
| `payload.page` | `integer` | No | — | Page number to be accessed Format: `int32`. |
| `payload.per_page` | `integer` | No | — | Number of items per page Format: `int32`. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Get all cadences",
"properties": {
"module": {
"type": "string",
"description": "Cadence supported modules like Leads, Contacts, Accounts, Deals, Quotes, Vendors or custom module",
"maxLength": 255
},
"name": {
"type": "string",
"description": "Filters by cadence name",
"maxLength": 100
},
"active": {
"type": "boolean",
"description": "Filters by cadence active status. Use true or false"
},
"fields": {
"type": "string",
"description": "Filters by fields. Use name",
"enum": [
"name"
]
},
"page": {
"type": "integer",
"description": "Page number to be accessed",
"format": "int32"
},
"per_page": {
"type": "integer",
"description": "Number of items per page",
"format": "int32"
}
},
"required": [],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ----------------------------------------------------------------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Response schema for getting all cadences |
| `result.data.cadences` | `array` | Yes | — | List of cadences Maximum items: 400. |
| `result.data.cadences[].summary` | `object` | No | — | A summary of follow-up actions including counts of WhatsApp, task, call, and email follow-ups. |
| `result.data.cadences[].summary.whatsapp_follow_up_count` | `integer` | No | — | Number of WhatsApp follow-ups Format: `int32`. |
| `result.data.cadences[].summary.task_follow_up_count` | `integer` | No | — | Number of task follow-ups Format: `int32`. |
| `result.data.cadences[].summary.call_follow_up_count` | `integer` | No | — | Number of call follow-ups Format: `int32`. |
| `result.data.cadences[].summary.email_follow_up_count` | `integer` | No | — | Number of email follow-ups Format: `int32`. |
| `result.data.cadences[].description` | `string` | No | — | Description of the cadence Maximum length: 500. |
| `result.data.cadences[].created_time` | `string` | No | — | Cadence creation time in ISO 8601 format Format: `date-time`. |
| `result.data.cadences[].module` | `object` | No | — | Details about an automation module, including its API name and unique identifier. |
| `result.data.cadences[].module.api_name` | `string` | No | — | API name of the module Maximum length: 255. |
| `result.data.cadences[].module.id` | `string` | No | — | ID of the module Maximum length: 255. |
| `result.data.cadences[].active` | `boolean` | No | — | Indicates if the cadence is active |
| `result.data.cadences[].execution_details` | `object \| null` | No | — | Details about cadence execution |
| `result.data.cadences[].execution_details.unenroll_properties` | `object` | No | — | Properties for automatic unenrollment from the cadence |
| `result.data.cadences[].execution_details.unenroll_properties.end_date` | `string` | No | — | End date for unenrollment Maximum length: 50. |
| `result.data.cadences[].execution_details.unenroll_properties.type` | `string \| null` | No | — | Type of unenrollment Maximum length: 255. |
| `result.data.cadences[].execution_details.end_date` | `string` | No | — | End date for cadence execution Maximum length: 50. |
| `result.data.cadences[].execution_details.automatic_unenroll` | `boolean` | No | — | Indicates if automatic unenrollment is enabled |
| `result.data.cadences[].execution_details.type` | `string \| null` | No | — | Type of execution Maximum length: 255. |
| `result.data.cadences[].execution_details.execute_every` | `object \| null` | No | — | cadence execute\_every |
| `result.data.cadences[].execution_details.execute_every.period` | `"immediately" \| "hours" \| "days" \| "weeks"` | Yes | — | Cadence execute\_every period (Required) Allowed: `immediately`, `hours`, `days`, `weeks`. |
| `result.data.cadences[].execution_details.execute_every.unit` | `integer` | No | — | Cadence execute\_every unit Format: `int32`. |
| `result.data.cadences[].published` | `boolean` | No | — | Indicates if the cadence is published |
| `result.data.cadences[].type` | `"custom_view" \| "manual_enrollment"` | No | — | Type of cadence enrollment Allowed: `custom_view`, `manual_enrollment`. |
| `result.data.cadences[].created_by` | `object` | No | — | Information about the creator of a record, including name and identifier. |
| `result.data.cadences[].created_by.name` | `string` | No | — | Name of the creator Maximum length: 255. |
| `result.data.cadences[].created_by.id` | `string` | No | — | ID of the creator Maximum length: 255. |
| `result.data.cadences[].modified_time` | `string \| null` | No | — | Cadence last modification time in ISO 8601 format Format: `date-time`. |
| `result.data.cadences[].name` | `string` | No | — | Name of the cadence Maximum length: 100. |
| `result.data.cadences[].modified_by` | `object \| null` | No | — | Information about the last person who modified a record, including name and identifier. |
| `result.data.cadences[].modified_by.name` | `string` | No | — | Name of the modifier Maximum length: 255. |
| `result.data.cadences[].modified_by.id` | `string` | No | — | ID of the modifier Maximum length: 255. |
| `result.data.cadences[].id` | `string` | No | — | ID of the cadence Maximum length: 255. |
| `result.data.cadences[].custom_view` | `object \| null` | No | — | Details of a custom view, including name and identifier. |
| `result.data.cadences[].custom_view.name` | `string` | No | — | Name of the custom view Maximum length: 255. |
| `result.data.cadences[].custom_view.id` | `string` | No | — | ID of the custom view Maximum length: 255. |
| `result.data.cadences[].status` | `"active" \| "inactive" \| "draft"` | No | — | Current status of the cadence Allowed: `active`, `inactive`, `draft`. |
| `result.data.info` | `object` | Yes | — | Information about the pagination |
| `result.data.info.per_page` | `integer` | No | — | Number of cadences per page Format: `int32`. |
| `result.data.info.count` | `integer` | No | — | Total number of cadences retrieved Format: `int32`. |
| `result.data.info.page` | `integer` | No | — | Current page number Format: `int32`. |
| `result.data.info.more_records` | `boolean` | No | — | Indicates if more records are available beyond the current page |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Response schema for getting all cadences",
"properties": {
"cadences": {
"type": "array",
"description": "List of cadences",
"maxItems": 400,
"items": {
"type": "object",
"description": "Cadence details",
"properties": {
"summary": {
"type": "object",
"description": "A summary of follow-up actions including counts of WhatsApp, task, call, and email follow-ups.",
"properties": {
"whatsapp_follow_up_count": {
"type": "integer",
"description": "Number of WhatsApp follow-ups",
"format": "int32"
},
"task_follow_up_count": {
"type": "integer",
"description": "Number of task follow-ups",
"format": "int32"
},
"call_follow_up_count": {
"type": "integer",
"description": "Number of call follow-ups",
"format": "int32"
},
"email_follow_up_count": {
"type": "integer",
"description": "Number of email follow-ups",
"format": "int32"
}
},
"additionalProperties": false
},
"description": {
"type": "string",
"description": "Description of the cadence",
"maxLength": 500
},
"created_time": {
"type": "string",
"description": "Cadence creation time in ISO 8601 format",
"format": "date-time"
},
"module": {
"type": "object",
"description": "Details about an automation module, including its API name and unique identifier.",
"properties": {
"api_name": {
"type": "string",
"description": "API name of the module",
"maxLength": 255
},
"id": {
"type": "string",
"description": "ID of the module",
"maxLength": 255
}
},
"additionalProperties": false
},
"active": {
"type": "boolean",
"description": "Indicates if the cadence is active"
},
"execution_details": {
"type": [
"object",
"null"
],
"description": "Details about cadence execution",
"properties": {
"unenroll_properties": {
"type": "object",
"description": "Properties for automatic unenrollment from the cadence",
"properties": {
"end_date": {
"type": "string",
"description": "End date for unenrollment",
"maxLength": 50
},
"type": {
"type": [
"string",
"null"
],
"description": "Type of unenrollment",
"maxLength": 255
}
},
"additionalProperties": false
},
"end_date": {
"type": "string",
"description": "End date for cadence execution",
"maxLength": 50
},
"automatic_unenroll": {
"type": "boolean",
"description": "Indicates if automatic unenrollment is enabled"
},
"type": {
"type": [
"string",
"null"
],
"description": "Type of execution",
"maxLength": 255
},
"execute_every": {
"type": [
"object",
"null"
],
"description": "cadence execute_every",
"properties": {
"period": {
"type": "string",
"description": "Cadence execute_every period (Required)",
"enum": [
"immediately",
"hours",
"days",
"weeks"
]
},
"unit": {
"type": "integer",
"description": "Cadence execute_every unit",
"format": "int32"
}
},
"required": [
"period"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"published": {
"type": "boolean",
"description": "Indicates if the cadence is published"
},
"type": {
"type": "string",
"description": "Type of cadence enrollment",
"enum": [
"custom_view",
"manual_enrollment"
]
},
"created_by": {
"type": "object",
"description": "Information about the creator of a record, including name and identifier.",
"properties": {
"name": {
"type": "string",
"description": "Name of the creator",
"maxLength": 255
},
"id": {
"type": "string",
"description": "ID of the creator",
"maxLength": 255
}
},
"additionalProperties": false
},
"modified_time": {
"type": [
"string",
"null"
],
"description": "Cadence last modification time in ISO 8601 format",
"format": "date-time"
},
"name": {
"type": "string",
"description": "Name of the cadence",
"maxLength": 100
},
"modified_by": {
"type": [
"object",
"null"
],
"description": "Information about the last person who modified a record, including name and identifier.",
"properties": {
"name": {
"type": "string",
"description": "Name of the modifier",
"maxLength": 255
},
"id": {
"type": "string",
"description": "ID of the modifier",
"maxLength": 255
}
},
"additionalProperties": false
},
"id": {
"type": "string",
"description": "ID of the cadence",
"maxLength": 255
},
"custom_view": {
"type": [
"object",
"null"
],
"description": "Details of a custom view, including name and identifier.",
"properties": {
"name": {
"type": "string",
"description": "Name of the custom view",
"maxLength": 255
},
"id": {
"type": "string",
"description": "ID of the custom view",
"maxLength": 255
}
},
"additionalProperties": false
},
"status": {
"type": "string",
"description": "Current status of the cadence",
"enum": [
"active",
"inactive",
"draft"
]
}
},
"additionalProperties": false
}
},
"info": {
"type": "object",
"description": "Information about the pagination",
"properties": {
"per_page": {
"type": "integer",
"description": "Number of cadences per page",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Total number of cadences retrieved",
"format": "int32"
},
"page": {
"type": "integer",
"description": "Current page number",
"format": "int32"
},
"more_records": {
"type": "boolean",
"description": "Indicates if more records are available beyond the current page"
}
},
"additionalProperties": false
}
},
"required": [
"cadences",
"info"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)