result.data | array | Yes | — | Provider response payload. |
result.data[].id | integer | No | — | ID of cadence |
result.data[].created_at | string | No | — | Datetime of when the cadence was created Format: date-time. |
result.data[].updated_at | string | No | — | Datetime of when the cadence was last updated Format: date-time. |
result.data[].archived_at | string | No | — | Datetime of when the cadence was archived, if archived Format: date-time. |
result.data[].latest_active_date | string | No | — | Date of when the cadence was last used Format: date. |
result.data[].team_cadence | boolean | No | — | Whether this cadence is a team cadence. A team cadence is created by an admin and can be run by all users |
result.data[].shared | boolean | No | — | Whether this cadence is visible to team members (shared) |
result.data[].archived | boolean | No | — | Whether this cadence is archived |
result.data[].remove_bounces_enabled | boolean | No | — | Whether this cadence is configured to automatically remove people who have bounced |
result.data[].remove_replies_enabled | boolean | No | — | Whether this cadence is configured to automatically remove people who have replied |
result.data[].opt_out_link_included | boolean | No | — | Whether this cadence is configured to include an opt-out link by default |
result.data[].draft | boolean | No | — | Whether this cadence is in draft mode |
result.data[].override_contact_restrictions | boolean | No | — | Whether this cadence is an Operational Cadence. An operational cadence is only created by an admin and accounts with the correct permission |
result.data[].cadence_framework_id | integer | No | — | ID of the cadence framework used to create steps for the cadence |
result.data[].archived_by | string | No | — | Name or email of the user who archived the cadence |
result.data[].knowledge_library_document_ids | array | No | — | IDs of knowledge library documents associated with this cadence |
result.data[].cadence_function | string | No | — | The use case of the cadence. Possible values are: outbound: Denotes an outbound cadence, typically for sales purposes inbound: Denotes an inbound sales cadence event: Denotes a cadence used for an upcoming event other: Denotes a cadence outside of the standard process |
result.data[].name | string | No | — | Cadence name |
result.data[].external_identifier | string | No | — | Cadence External ID |
result.data[].tags | array | No | — | All tags applied to this cadence |
result.data[].current_state | string | No | — | The state of the Cadence. Read Only. Valid states are: draft, pending_review, active, archived, expired, deleted |
result.data[].creator | object | No | — | User that created this cadence |
result.data[].creator.id | integer | No | — | — |
result.data[].creator._href | string | No | — | — |
result.data[].owner | object | No | — | User that is marked as the owner of this cadence |
result.data[].owner.id | integer | No | — | — |
result.data[].owner._href | string | No | — | — |
result.data[].bounced_stage | object | No | — | Stage set when person on cadence bounces |
result.data[].bounced_stage.id | integer | No | — | — |
result.data[].bounced_stage._href | string | No | — | — |
result.data[].replied_stage | object | No | — | Stage set when person on cadence replies |
result.data[].replied_stage.id | integer | No | — | — |
result.data[].replied_stage._href | string | No | — | — |
result.data[].added_stage | object | No | — | Stage set when person is added to cadence |
result.data[].added_stage.id | integer | No | — | — |
result.data[].added_stage._href | string | No | — | — |
result.data[].finished_stage | object | No | — | Stage set when person is finished with cadence |
result.data[].finished_stage.id | integer | No | — | — |
result.data[].finished_stage._href | string | No | — | — |
result.data[].cadence_priority | object | No | — | Priority of the cadence |
result.data[].cadence_priority.id | integer | No | — | — |
result.data[].cadence_priority._href | string | No | — | — |
result.data[].groups | array | No | — | Groups to which this cadence is assigned, if any |
result.data[].groups[].id | integer | No | — | — |
result.data[].groups[]._href | string | No | — | — |
result.data[].counts | object | No | — | — |
result.data[].counts.cadence_people | integer | No | — | The number of people that have ever been added to the cadence |
result.data[].counts.people_acted_on_count | integer | No | — | The number of people that have been skipped, scheduled, or advanced in a cadence |
result.data[].counts.target_daily_people | integer | No | — | The user defined target for number of people to add to the cadence each day |