Cadences
Returns multiple cadence records. The records can be filtered, paged, and sorted according to the respective parameters.
Columns
| Name | Type | Description |
| Id [KEY] | Integer | The Id of the Cadence. |
| AddedStageId | Integer | The AddedStageId of the Cadence. |
| ArchivedAt | Datetime | The ArchivedAt of the Cadence. |
| BouncedStageId | Integer | The BouncedStageId of the Cadence. |
| CountsCadencePeople | Integer | The CountsCadencePeople of the Cadence. |
| CountsTargetDailyPeople | Integer | The CountsTargetDailyPeople of the Cadence. |
| CreatedAt | Datetime | The CreatedAt of the Cadence. |
| CreatorId | Integer | The CreatorId of the Cadence. |
| FinishedStageId | Integer | The FinishedStageId of the Cadence. |
| Name | String | The Name of the Cadence. |
| OptOutLinkIncluded | Boolean | The OptOutLinkIncluded of the Cadence. |
| OwnerId | Integer | The OwnerId of the Cadence. |
| RemoveBouncesEnabled | Boolean | The RemoveBouncesEnabled of the Cadence. |
| RemoveRepliesEnabled | Boolean | The RemoveRepliesEnabled of the Cadence. |
| RepliedStageId | Integer | The RepliedStageId of the Cadence. |
| Shared | Boolean | The Shared of the Cadence. |
| Tags | String | The Tags of the Cadence. |
| TeamCadence | Boolean | The TeamCadence of the Cadence. |
| UpdatedAt | Datetime | The UpdatedAt of the Cadence. |
| PeopleAddable | Boolean | The PeopleAddable property of the Cadence table. |
| OwnedByGuid | String | The OwnedByGuid property of the Cadence table. |
| LatestActiveDate | Date | Date of when the cadence was last used. |
| Archived | Boolean | Whether this cadence is archived. |
| Draft | Boolean | Whether this cadence is in draft mode. |
| OverrideContactRestrictions | Boolean | Whether this cadence is an Operational Cadence. An operational cadence is only created by an admin and accounts with the correct permission. |
| CadenceFrameworkId | Integer | ID of the cadence framework used to create steps for the cadence. |
| ArchivedBy | String | Name or email of the user who archived the cadence. |
| CadenceFunction | String | 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. |
| ExternalIdentifier | String | Cadence External ID. |
| CurrentState | String | The state of the Cadence. Read Only. Valid states are: draft, active, archived, expired, deleted. |
| CreatorId | Integer | The Id of the User that created this cadence. |
| CadencePriorityId | Integer | The Priority Id of the cadence. |
| GroupIds | String | GroupIds (comma-separated) to which this cadence is assigned, if any. |
| CountsCadencePeople | Integer | The number of people that have ever been added to the cadence. |
| CountsPeopleActedOnCount | Integer | The number of people that have been skipped, scheduled, or advanced in a cadence. |
| CountsTargetDailyPeople | Integer | The user defined target for number of people to add to the cadence each day. |
| CountsOpportunitiesCreated | Integer | The number of opportunities created and attributed to the cadence. |
| CountsMettingsBooked | Integer | The number of meetings booked and attributed to the cadence. |
| PendingActionsAssignedTo | String | Filters by whether the Cadence has at least one pending cadence action assigned to any of the provided accounts. |