Skip to main content

Fetch a cadence

GET 
/v2/cadences/:id

Fetches a cadence, by ID only.

Request​

Path Parameters

    id stringrequired

    Cadence ID

Responses​

Success

Schema
    id integer

    ID of cadence

    created_at date-time

    Datetime of when the cadence was created

    updated_at date-time

    Datetime of when the cadence was last updated

    archived_at date-time

    Datetime of when the cadence was archived, if archived

    latest_active_date date

    Date of when the cadence was last used

    team_cadence boolean

    Whether this cadence is a team cadence. A team cadence is created by an admin and can be run by all users

    shared boolean

    Whether this cadence is visible to team members (shared)

    archived boolean

    Whether this cadence is archived

    remove_bounces_enabled boolean

    Whether this cadence is configured to automatically remove people who have bounced

    remove_replies_enabled boolean

    Whether this cadence is configured to automatically remove people who have replied

    opt_out_link_included boolean

    Whether this cadence is configured to include an opt-out link by default

    draft boolean

    Whether this cadence is in draft mode

    override_contact_restrictions boolean

    Whether this cadence is an Operational Cadence. An operational cadence is only created by an admin and accounts with the correct permission

    cadence_framework_id integer

    ID of the cadence framework used to create steps for the cadence

    archived_by string

    Name or email of the user who archived the cadence

    cadence_function 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

    name string

    Cadence name

    external_identifier string

    Cadence External ID

    tags string[]

    All tags applied to this cadence

    current_state string

    The state of the Cadence. Read Only. Valid states are: draft, active, archived, expired, deleted

    creator object

    User that created this cadence

    id integer
    _href string
    owner object

    User that is marked as the owner of this cadence

    id integer
    _href string
    bounced_stage object

    Stage set when person on cadence bounces

    id integer
    _href string
    replied_stage object

    Stage set when person on cadence replies

    id integer
    _href string
    added_stage object

    Stage set when person is added to cadence

    id integer
    _href string
    finished_stage object

    Stage set when person is finished with cadence

    id integer
    _href string
    cadence_priority object

    Priority of the cadence

    id integer
    _href string
    groups object[]

    Groups to which this cadence is assigned, if any

  • Array [
    • id integer
    _href string
  • ]
    • counts object
    cadence_people integer

    The number of people that have ever been added to the cadence

    people_acted_on_count integer

    The number of people that have been skipped, scheduled, or advanced in a cadence

    target_daily_people integer

    The user defined target for number of people to add to the cadence each day

    opportunities_created integer

    The number of opportunities created and attributed to the cadence

    meetings_booked integer

    The number of meetings booked and attributed to the cadence

Loading...