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). |