List Workflow Definitions

Retrieve a paginated list of workflow definitions (available workflow types).

Workflow definitions are the deployed pipeline templates that can be configured with custom settings, schedules, and triggers.

Supports filtering by:

• workflow_type: Filter by workflow type
• is_active: Filter by active status
• data_asset_type: Filter workflows that support a specific data asset type

This endpoint is useful for discovering available workflow types that can be configured for execution.

GET /api/data-readiness/workflows/definitions

List Workflow Definitions

cURL

curl --request GET \
  --url https://api.example.com/api/data-readiness/workflows/definitions \
  --header 'Authorization: Bearer <token>'

200

{
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123,
    "has_next": true,
    "has_prev": true
  },
  "data": [
    {
      "category": "enrichment",
      "created_at": "2024-01-01T00:00:00Z",
      "data_asset_types": [
        "table"
      ],
      "description": "Detects and tags PII data in tables",
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "is_active": true,
      "name": "Generate PII Tags",
      "require_reference_pack": true,
      "requires_approval": true,
      "workflow_type": "generate-pii-tags"
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT Bearer token authentication. Include the token in the Authorization header as: Authorization: Bearer <token>. The JWT must contain valid client_id, and project_id claims for tenant isolation and SDK routing.

Query Parameters

page · integer · default: 1

Page number (1-indexed)

Required range: x >= 1

Example:

1

per_page · integer · default: 20

Items per page (max 100)

Required range: 1 <= x <= 100

Example:

20

workflow_type · enum<string> | null

Filter by workflow type Workflow types available in the system.

These values match the Prefect deployment names defined in scripts/prefect/deploy.py to enable direct mapping when triggering workflows.

Available options: generate-table-description, generate-pii-tags, generate-dq-tags, generate-sensitivity-tags, enrich-table-columns, service-ingestion, profiling, dq-rule-generation, dq-execution, metadata-assessment, dq-assessment, dq-tag-generation, intelligence, metadata-enrichment, run-all-enrichment

Example:

"generate-pii-tags"

is_active · boolean | null · default: true

Filter by active status. Defaults to true (active only). Pass false to see retired definitions; omit or pass null to see all.

data_asset_type · string | null

Filter workflows that support a specific data asset type

Example:

"table"

Response

200

application/json

Successful Response

Paginated list of workflow definitions.

pagination · PaginationMeta · object · required

Pagination metadata

Show child attributes

data · WorkflowDefinitionListItem · object[]

List of workflow definition items

Show child attributes