Skip to main content

List actions

GET 
/v2/actions

Fetches multiple action records. The records can be filtered, paged, and sorted according to the respective parameters. Only actions that are currently "in_progess" will be returned by this endpoint.

If the requester is not an admin, this endpoint will only return actions belonging to the requester. If the request is an admin, this endpoint will return actions for the entire team. Additionaly, an admin may use the user_guid parameter to request actions that belong to specific users on the team.

Request​

Query Parameters

    ids integer[]

    IDs of actions to fetch.

    step_id integer

    Fetch actions by step ID

    Example: 1
    type string

    Filter actions by type

    Example: phone
    due_on[gt] iso8601 string

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

    due_on[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.

    due_on[lt] iso8601 string

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

    due_on[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.

    user_guid string[]

    Filters actions by the user's guid. Multiple user guids can be applied. The user must be a team admin to filter other users' actions

    Example: [9cc6da15-d403-4f5b-aeed-c4b8463cf9ae]
    person_id integer[]

    Filters actions by person_id. Multiple person ids can be applied

    Example: [6759304]
    cadence_id integer[]

    Filters actions by cadence_id. Multiple cadence ids can be applied

    Example: [63458999]
    multitouch_group_id integer[]

    Filters actions by multitouch_group_id. Multiple multitouch group ids can be applied

    Example: [6269709]
    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.

    sort_by string

    Key to sort on, must be one of: created_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

    ID of Action

    due boolean

    Whether this step is due

    created_at date-time

    Datetime of when the Action was created

    updated_at date-time

    Datetime of when the Action was last updated

    type string

    The type of this action. Valid types are: email, phone, other. New types may be added in the future.

    status string

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

    in_progress: this action has not been completed

    pending_activity: this action has been acted upon, but the action has not been completed. (i.e. the email is scheduled to send, but has not been delivered yet)

    due_on date-time

    When action is due

    multitouch_group_id integer

    ID of the multitouch group

    action_details object

    The type specific action details

    id integer
    _href string
    user object

    User assigned to action

    id integer
    _href string
    person object

    The subject of an action

    id integer
    _href string
    cadence object

    The cadence of an action

    id integer
    _href string
    step object

    The step of an action

    id integer
    _href string
    task object

    The task associated with an action

    id integer
    _href string
Loading...