List Workflow Configurations

Retrieve a paginated list of workflow configurations available to the current user.

Supports filtering by:

• data_asset_type: Filter configurations linked to a specific data asset type
• workflow_type: Filter by type (generate-pii-tags, generate-dq-tags, etc.)
• status: Filter by configuration status
• has_schedule: Filter configurations with active schedules
• has_triggers: Filter configurations with active triggers
• search: Search by workflow name/description

The response includes summary schedule information and triggers. Use the Get Configuration endpoint for full configuration details.

GET /api/data-readiness/workflows

List Workflow Configurations

cURL

curl --request GET \
  --url https://api.example.com/api/data-readiness/workflows \
  --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-15T10:30:00Z",
      "data_asset_types": [
        "table"
      ],
      "description": "Detects and tags PII in production tables",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "is_default": false,
      "name": "PII Detection - Production",
      "require_reference_pack": true,
      "schedule": {
        "cron_expression": "0 0 * * *",
        "enabled": true
      },
      "status": "active",
      "triggers": [],
      "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

data_asset_type · string | null

Filter configurations linked to a specific data asset type

Example:

"table"

workflow_type · string | null

Filter by workflow type

Example:

"generate-pii-tags"

status · string | null

Filter by configuration status

Example:

"active"

has_schedule · boolean | null

Filter configurations with active schedules

has_triggers · boolean | null

Filter configurations with active triggers

search · string | null

Search by workflow name/description

Maximum string length: 255

Response

200

application/json

Successful Response

Paginated list of workflow configurations.

pagination · PaginationMeta · object · required

Pagination metadata

Show child attributes

data · WorkflowConfigurationListItem · object[]

List of configuration items

Show child attributes