Cadences

Cadences in Zoho CRM automates and streamlines customer follow-up processes. It enables users to create targeted, sequential communications, like emails, calls, or tasks, based on customer interactions and behaviours. Ideal for sales and marketing professionals, it maintains consistent, personalized follow-ups with leads and prospects until a desired outcome is achieved.

Refer to the Cadence for key features and business scenarios of Cadences.

Purpose

Use this API to get the details of cadences configured in your organization.

Endpoints

GET /settings/automation/cadences

Request Details

Request URL

{api-domain}/crm/{version}/settings/automation/cadences

Supported Modules

Leads, Contacts, Deals, Vendors, and Custom modules.

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.cadences.ALL
(or)
ZohoCRM.settings.cadences.READ

Note

This feature is supported for the Standard and above editions.

Parameters

filtersJSON, optional
Filters the response based on the specified criteria. You can filter cadences by the name, status, module, and type fields. URL-encode the JSON value before passing it in the request.
The filters parameter accepts a JSON object with the following properties:
- field - An object that specifies the field to filter on. Set the field API name using the api_name property. Example: {"field":{"api_name":"module.api_name"}}
- comparator - The comparison operator used to evaluate the field value.
- value - The value used for comparison.
Structure for the filters parameter:
{
  "field": {
    "api_name": "{field_api_name}"
  },
  "comparator": "{comparator}",
  "value": "{value}"
}
Specify one of the following values for field.api_name:
- name
  Filters cadences by name.
  Supported comparators: equal, not_equal, contains, not_contains, starts_with, ends_with
  Example: {"field":{"api_name":"name"},"comparator":"contains","value":"cadence"}
- status
  Filters cadences by status.
  Supported comparators: equal
  Allowed values: active, inactive, draft
  Example: {"field":{"api_name":"status"},"comparator":"equal","value":"active"}
- module.api_name
  Filters cadences by module.
  Supported comparators: equal
  Allowed values: API name of a standard module (such as Leads, Contacts, or Vendors) or a custom module
  Example: {"field":{"api_name":"module.api_name"},"comparator":"equal","value":"Leads"}
- type
  Filters cadences by type.
  Supported comparators: equal
  Allowed values: manual_enrollment, custom_view
  Example: {"field":{"api_name":"type"},"comparator":"equal","value":"manual_enrollment"}
fieldsstring, optional
Pass "name" to retrieve only the name,id and description fields of Cadences.
per_pageinteger, optional
The number of records you want to fetch per page. The default and the maximum possible value is 200. Accepts positive integer values only.
pageinteger, optional
To get the list of records from the respective pages. The default value is 1. Accepts positive integer values only.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/automation/cadences?filters=%7B%22field%22%3A%7B%22api_name%22%3A%22module.api_name%22%7D%2C%22comparator%22%3A%22equal%22%2C%22value%22%3A%22Contacts%22%7D"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON

The cadences JSON array consists of the details of the cadences configured in your Zoho CRM organization. It includes the following keys:

summaryJSON object
Represents the count of follow-up steps configured on the cadence based on different action types.
- email_follow_up_countinteger
  Represents the number of email notification follow-up steps configured in this cadence.
- task_follow_up_countinteger
  Represents the number of task follow-up steps configured in this cadence.
- call_follow_up_countinteger
  Represents the number of scheduled-call follow-up steps configured in this cadence.
- whatsapp_follow_up_countinteger
  Represents the number of WhatsApp message follow-up steps configured in this cadence.
descriptionstring
Represents the description of the cadence.
created_timestring
Represents the timestamp when the cadence was created.
moduleJSON object
Represents the details of the Zoho CRM module to which the cadence applies.
- api_namestring
  Represents the API name of the module.
- idstring
  Represents the ID of the module.
activeBoolean
Represents that the cadence is currently published and enrolling records when values is true. For inactive or draft cadences it will be marked as false.
execution_detailsJSON object
Represents the lightweight execution details included in the list view, covering the execute_every schedule and legacy un-enroll configuration fields.
- unenroll_propertiesJSON object
  Represents the legacy unenroll configuration in single-object form.
  - end_datestring
    Represents the date on which the record must be un-enrolled (YYYY-MM-DD).
  - typestring
    Represents the legacy unenroll type flag.
    Possible values: automatic_unenroll, respond_email, date.
- end_datestring
  Represents the cadence-wide stop date. Records remaining in any cadence state beyond this date are un-enrolled.
- automatic_unenrollBoolean
  Represents that the cadence is configured to automatically un-enroll records that fall out of the custom view when marked as true. Applicable only for Custom view cadences.
- typestring
  Represents the legacy execution mode marker for the cadence.
- execute_everyJSON object
  Represents the schedule interval at which the cadence is executed.
publishedBoolean
True when the cadence has been published at least once. Draft cadences return false.
typestring
Represents the display form of the cadence enrollment mode.
Possible values: Custom view, Manual enrollment.
created_byJSON object
Represents the details of the user who created the cadence.
- idstring
  Represents the ID of the user who created the cadence.
- namestring
  Represents the name of the user who created the cadence.
modified_timestring
Represents the timestamp of the most recent modification to the cadence.
namestring
Represents the name of the cadence.
modified_byJSON object
Represents the details of the user who last modified the cadence.
- idstring
  Represents the ID of the user who last modified the cadence.
- namestring
  Represents the name of the user who last modified the cadence.
idstring
Represents the unique identifier of the cadence.
custom_viewJSON object
Represents the details of the custom view associated with the cadence. Applicable only for cadences of type Custom view.
- idstring
  Represents the ID of the custom view.
- namestring
  Represents the name of the custom view.
statusstring
Represents the cadence lifecycle status.
Possible values::
active: published and enrolling records
inactive: published but currently deactivated
draft: not yet published.

Possible Errors

INVALID_DATAHTTP 400
You have specified an invalid value to the "filters" parameter.
Resolution: The "filters" parameter accepts a URL-encoded JSON object. Refer to the "details" key in the error response for the exact error and specify valid values to the parameters. Refer to the Parameters section for the list of accepted values and supported comparators.
NOT_SUPPORTEDHTTP 400
The value given for the "filters" parameter is not supported.
Resolution: Refer to the "details" key in the error response for the exact error and specify valid values to the parameters. Refer to the Parameters section for the list of accepted values and supported comparators.
DEPENDENT_FIELD_MISSINGHTTP 400
You have not specified one or more fields and their values in the "filters" parameter. For example, you may have specified the API name of the field, but not the comparator or the field's value.
Resolution: Refer to the "details" key in the error response for the exact error and specify valid values to the parameters. Refer to the Parameters section for the list of accepted values and supported comparators.
DEPENDENT_MISMATCHHTTP 400
You have not specified the accepted comparator for a specific field type. For example, the "type" field supports only "equal" comparator but you have used "contains".
Resolution: Refer to the "details" key in the error response for the exact error and specify valid values to the parameters. Refer to the Parameters section for the list of accepted values and supported comparators.
MANDATORY_NOT_FOUNDHTTP 400
You have not specified the API name of the field in the "filters" parameter.
Resolution: Refer to the "details" key in the error response for the exact error and specify valid values to the parameters. Refer to the Parameters section for the list of accepted values and supported comparators.
OAUTH_SCOPE_MISMATCHHTTP 401
You do not have the right scope to access this API.
Resolution: Create a new token with the scopes mentioned in the Scopes section and try this API.
FEATURE_NOT_ENABLEDHTTP 403
Feature is not supported in this edition.
Resolution:Supported editions: Standard and above. Contact support@zohocrm.com or upgrade your edition.
NO_PERMISSIONHTTP 403
You do not have the Manage Cadences permission to access this API.
Resolution: Contact your administrator to get the required permission to access the API.
INTERNAL_SERVER_ERRORHTTP 500
Unhandled and unexpected exception in server.
Resolution: Contact support@zohocrm.com for assistance.

Sample Response

Copied{
    "cadences": [
        {
            "summary": {
                "whatsapp_follow_up_count": 0,
                "task_follow_up_count": 1,
                "call_follow_up_count": 0,
                "email_follow_up_count": 1
            },
            "created_time": "2024-07-29T03:51:51+00:00",
            "module": {
                "api_name": "Contacts",
                "id": "554023000000000129"
            },
            "description": "",
            "active": true,
            "execution_details": null,
            "published": true,
            "type": "Manual enrollment",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "554023000000235011"
            },
            "modified_time": "2024-07-29T03:53:53+00:00",
            "name": "CadenceTest1",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "554023000000235011"
            },
            "id": "554023000004092008",
            "custom_view": null,
            "status": "active"
        },
        {
            "summary": {
                "whatsapp_follow_up_count": 0,
                "task_follow_up_count": 0,
                "call_follow_up_count": 0,
                "email_follow_up_count": 0
            },
            "created_time": "2026-02-23T04:57:56+00:00",
            "module": {
                "api_name": "Contacts",
                "id": "554023000000000129"
            },
            "description": "descriptionNew",
            "active": false,
            "execution_details": {
                "unenroll_properties": {
                    "end_date": "",
                    "type": null
                },
                "end_date": "",
                "automatic_unenroll": false,
                "type": null,
                "execute_every": {
                    "unit": 1,
                    "period": "hours"
                }
            },
            "published": true,
            "type": "Custom view",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "554023000000235011"
            },
            "modified_time": "2026-03-25T06:58:05+00:00",
            "name": "cadence3New",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "554023000000235011"
            },
            "id": "554023000006316030",
            "custom_view": {
                "name": "All Leads",
                "id": "554023000000091501"
            },
            "status": "draft"
        }
    ],
    "info": {
        "per_page": 50,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}