Skip to main content
GET
/
api
/
data-readiness
/
workflows
List Workflow Configurations
curl --request GET \
  --url https://api.example.com/api/data-readiness/workflows \
  --header 'Authorization: Bearer <token>'
{
  "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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.emergence.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

Successful Response

Paginated list of workflow configurations.

pagination
PaginationMeta · object
required

Pagination metadata

data
WorkflowConfigurationListItem · object[]

List of configuration items