Skip to main content

List cadence memberships

GET 
/v2/cadence_memberships

Fetches multiple cadence membership records. The records can be filtered, paged, and sorted according to the respective parameters. A cadence membership is the association between a person and their current and historical time on a cadence. Cadence membership records are mutable and change over time. If a person is added to a cadence and re-added to the same cadence in the future, there is a single membership record.

Request​

Query Parameters

    ids integer[]

    IDs of cadence memberships to fetch. If a record can't be found, that record won't be returned and your request will be successful

    person_id integer

    ID of the person to find cadence memberships for

    cadence_id integer

    ID of the cadence to find cadence memberships for

    updated_at[gt] iso8601 string

    Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[gte] iso8601 string

    Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[lt] iso8601 string

    Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[lte] iso8601 string

    Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    currently_on_cadence boolean

    If true, return only cadence memberships for people currently on cadences. If false, return cadence memberships for people who have been removed from or have completed a cadence.

    Example: true
    sort_by string

    Key to sort on, must be one of: added_at, updated_at. Defaults to updated_at

    sort_direction string

    Direction to sort in, must be one of: ASC, DESC. Defaults to DESC

    per_page integer

    How many records to show per page in the range [1, 100]. Defaults to 25

    page integer

    The current page to fetch results from. Defaults to 1

    include_paging_counts boolean

    Whether to include total_pages and total_count in the metadata. Defaults to false

    limit_paging_counts boolean

    Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data

Responses​

Success

Schema
    id integer

    Cadence membership ID

    added_at date-time

    Datetime of when the person was last added to this cadence

    created_at date-time

    Datetime of when the person was first added to this cadence

    updated_at date-time

    Datetime of when the record was last updated

    person_deleted boolean

    Whether the associated person has since been deleted

    currently_on_cadence boolean

    Whether the person is currently on the cadence

    current_state string

    The current state of the person on the cadence. Possible values are:

    processing: The person is being processed on a cadence. Cadence-related changes cannot be made at this time

    staged: The person is waiting for the first step in the cadence to occur

    active: The cadence has begun processing this person and is still in the process, but idle

    scheduled: The cadence has begun processing this person and is still in the process, with an activity scheduled to occur

    completed: The cadence has been completed for this person

    removed: The person was manually or automatically removed from the cadence

    removed_no_action: The person was removed from the cadence before any action occurred

    reassigned: The person's cadence execution was transferred to a different user, ending this user's interaction

    archived: The cadence this person belonged to has been archived and all actions and people were archived with it

    cadence object

    The cadence that the person is on

    id integer
    _href string
    person object

    The person that is on the cadence

    id integer
    _href string
    user object

    The user that is acting on the person in the cadence

    id integer
    _href string
    latest_action object

    The most recent action associated with the record

    id integer
    counts object
    views integer

    The number of times emails sent from the cadence to the person were opened

    clicks integer

    The number of times emails sent from the cadence to the person were clicked

    replies integer

    The number of times emails sent from the cadence to the person were replied to

    calls integer

    The number of times a call was logged from the cadence to the person

    sent_emails integer

    The number of times emails were sent from the cadence to the person

    bounces integer

    The number of times emails sent from the cadence to the person bounced

Loading...