List Workflow Tests

List workflow tests.

Requires workflow_id and returns its saved tests as a cursor-paginated list, each with its latest-run summaries and drift status. Optionally filter to one block with target_block_id. Returns 404 if the workflow does not exist.

GET /v1/workflows/tests

Python

from retab import Retab

client = Retab()

# All tests for a workflow.
tests = client.workflows.tests.list(
    workflow_id="wf_abc123xyz",
    limit=50,
)

# Only tests for one specific block.
tests_for_block = client.workflows.tests.list(
    workflow_id="wf_abc123xyz",
    target_block_id="block_extract_invoice",
    limit=20,
)

print(f"Workflow has {len(tests.data)} tests")

200

{
  "data": [
    {
      "id": "wfnodetest_hsLEQiM61ez9Piv147MWk",
      "workflow_id": "wf_abc123xyz",
      "target": { "type": "block", "block_id": "block_extract_invoice" },
      "source": {
        "type": "run_step",
        "run_id": "wfrun_def456",
        "step_id": "block_extract_invoice"
      },
      "name": "Q1 invoice total",
      "assertion": {
        "id": "assert_xyz",
        "target": { "output_handle_id": "output-json-0", "path": "total" },
        "condition": { "kind": "equals", "expected": 1234.56 },
        "label": null
      },
      "assertion_schema_dep": {
        "schema_path": "total",
        "subtree_hash": "7d79dd764ab6548d",
        "depends_on_root": false
      },
      "assertion_drift_status": null,
      "schema_drift": "none",
      "schema_drift_detail": null,
      "validation_status": "valid",
      "validation_issues": [],
      "latest_run_summary": {
        "run_record_id": "wfnodetestrun_abc123",
        "status": "passed",
        "started_at": "2026-05-01T13:55:00Z",
        "completed_at": "2026-05-01T13:55:18Z",
        "duration_ms": 18221,
        "workflow_draft_fingerprint": "ddd95baadce6045f",
        "block_config_fingerprint": "0ff93ddc7cefcb42",
        "assertions_passed": 1,
        "assertions_failed": 0,
        "blocked_assertions": 0
      },
      "latest_passing_run_summary": { "...": "as above" },
      "latest_failing_run_summary": null,
      "created_at": "2026-04-08T14:22:26Z",
      "updated_at": "2026-04-08T14:27:52Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

List all workflow tests for a workflow. Optionally filter by target_block_id to get only the tests that target a specific block.

Each entry in data is a full WorkflowTest (target, source, assertion, schema-drift state, latest run summaries). Use this to populate a Tests page or to check whether a workflow has any tests before offering to run them.

The response uses the canonical Retab list envelope: { "data": [...], "list_metadata": { "before": null, "after": null } }.

Python

from retab import Retab

client = Retab()

# All tests for a workflow.
tests = client.workflows.tests.list(
    workflow_id="wf_abc123xyz",
    limit=50,
)

# Only tests for one specific block.
tests_for_block = client.workflows.tests.list(
    workflow_id="wf_abc123xyz",
    target_block_id="block_extract_invoice",
    limit=20,
)

print(f"Workflow has {len(tests.data)} tests")

200

{
  "data": [
    {
      "id": "wfnodetest_hsLEQiM61ez9Piv147MWk",
      "workflow_id": "wf_abc123xyz",
      "target": { "type": "block", "block_id": "block_extract_invoice" },
      "source": {
        "type": "run_step",
        "run_id": "wfrun_def456",
        "step_id": "block_extract_invoice"
      },
      "name": "Q1 invoice total",
      "assertion": {
        "id": "assert_xyz",
        "target": { "output_handle_id": "output-json-0", "path": "total" },
        "condition": { "kind": "equals", "expected": 1234.56 },
        "label": null
      },
      "assertion_schema_dep": {
        "schema_path": "total",
        "subtree_hash": "7d79dd764ab6548d",
        "depends_on_root": false
      },
      "assertion_drift_status": null,
      "schema_drift": "none",
      "schema_drift_detail": null,
      "validation_status": "valid",
      "validation_issues": [],
      "latest_run_summary": {
        "run_record_id": "wfnodetestrun_abc123",
        "status": "passed",
        "started_at": "2026-05-01T13:55:00Z",
        "completed_at": "2026-05-01T13:55:18Z",
        "duration_ms": 18221,
        "workflow_draft_fingerprint": "ddd95baadce6045f",
        "block_config_fingerprint": "0ff93ddc7cefcb42",
        "assertions_passed": 1,
        "assertions_failed": 0,
        "blocked_assertions": 0
      },
      "latest_passing_run_summary": { "...": "as above" },
      "latest_failing_run_summary": null,
      "created_at": "2026-04-08T14:22:26Z",
      "updated_at": "2026-04-08T14:27:52Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

Authorizations

Api-Key · string · header · required

Query Parameters

workflow_id · string · required

target_block_id · string | null

before · string | null

after · string | null

limit · integer · default: 50

Required range: 1 <= x <= 100

order · enum<string> · default: desc

Available options: asc, desc

Response

200

application/json

Successful Response

A page of WorkflowTest resources. data holds the items and list_metadata carries the before/after cursors; pass after to fetch the next page.

data · WorkflowTest · object[] · required

Show child attributes

list_metadata · ListMetadata · object · required

Boundary resource IDs for page navigation.

Show child attributes