v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Contacts::RunWorkflowAction

List Run Workflow Actions

List all Contact Run Workflow Actions for your workspace

get/workspaces/{workspace_id}/contacts/run_workflow_actions

Path parameters

workspace_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

idinteger

Run Workflow Action ID

public_idstring nullable

Run Workflow Action public ID

workspace_idinteger

Workspace ID

workflow_idinteger

ID of the workflow to run against the targeted contacts.

force_runboolean nullable

When true, contacts already in the workflow are re-enqueued. Defaults to false.

filter_idinteger nullable

ID of the Refine::StoredFilter that drives target selection. Populated automatically when stable_id or stored_filter_id is supplied on create. null when the action targets explicit target_ids or target_all.

target_allboolean nullable

When true the action targets every contact in the workspace. Mutually exclusive with stable_id, stored_filter_id, and target_ids.

target_idsinteger[] nullable

Explicit list of targeted contacts as raw integer IDs. The response echoes the stored integer IDs, not the public IDs passed on create.

target_countinteger nullable

Total number of contacts selected for this action. null until the async job has resolved the audience size.

performed_countinteger nullable

Number of contacts processed so far. Poll this field alongside target_count to track async progress.

created_by_idinteger nullable

ID of the workspace membership that created this action.

approved_by_idinteger nullable

ID of the membership that approved this action (reserved for future use).

scheduled_forstring date-time nullable

When set, the action will not execute until this datetime. null means execute immediately.

started_atstring date-time nullable

Datetime the async job began processing contacts. null until started.

completed_atstring date-time nullable

Datetime the async job finished. null until complete.

created_atstring date-time nullable

Created at datetime

updated_atstring date-time nullable

Updated at datetime

Example response

[
  {
    "id": 1,
    "public_id": "bC4dE5",
    "workspace_id": 42000,
    "workflow_id": 99,
    "force_run": false,
    "filter_id": 7,
    "target_all": false,
    "target_ids": [],
    "target_count": 500,
    "performed_count": 100,
    "created_by_id": 5,
    "approved_by_id": null,
    "scheduled_for": null,
    "started_at": "2025-01-01T00:01:00.000Z",
    "completed_at": null,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:01:00.000Z"
  }
]