Skip to main content
GET
Get a list of workflows

Authorizations

x-api-key
string
header
required

API key for authentication

Query Parameters

Search term to filter workflows by name or workflow ID

skip
integer
default:0

Number of items to skip

Required range: x >= 0
limit
integer
default:25

Maximum number of items to return

Required range: x >= 1
state
enum<string>

Filter by the persisted state of the long-lived workflow. Use displayState for its computed operational status, statusFilters for dashboard categories, and inSupport for support ownership. DRAFT workflows are excluded by default unless explicitly requested.

Available options:
ACTIVE,
DRAFT,
PAUSED,
PREVIEW,
QUEUED,
SETUP,
COMPLIANCE_REVIEW,
COMPLIANCE_REJECTED,
NOT_SUPPORTED,
ERROR,
DELETED
runState
enum<string>

Filter by the latest execution attempt. Use this for run diagnostics, not workflow status UI.

Available options:
FAILED,
FINISHED,
RUNNING,
STOPPED
displayState
enum<string>

Filter by the workflow's computed operational state. This does not include pending user input or support ownership; use statusFilters for those dashboard categories. Accepts comma-separated values.

Available options:
ACTIVE,
DRAFT,
PAUSED,
PREVIEW,
FAILED,
RUNNING,
VALIDATING,
PENDING_START,
COMPLIANCE_REVIEW,
COMPLIANCE_REJECTED
inSupport
enum<string>

Filter workflows by support status (has open support request)

Available options:
true,
false
tags
string[]

Filter workflows by tags. Accepts repeated params, comma-separated values, or a JSON array.

statusFilters
enum<string>[]

Filter by dashboard category. group:attention returns the workflows shown under "Needs your attention" in the dashboard, which is where the requesting user must reply to the Assistant or approve preview data. Accepts repeated params, comma-separated values, or a JSON array. The API also accepts dashboard-internal composite values sent by the Kadoa dashboard; those are not part of the public contract and may change.

Available options:
group:attention,
group:working,
group:support,
group:failed,
group:active,
group:complete,
group:paused
view
enum<string>

Use dashboard for a compact list without schema, notificationConfig, additionalData, or monitored_fields. Includes summaryOnly, hasPrompt, and hasSchema flags. Omit for the full list representation. CSV exports are unchanged.

Available options:
dashboard
groupWindows
string

Dashboard-only grouped list mode. JSON object mapping expanded dashboard groups to an offset and batch limit. Omitted groups return counts but no workflow rows. The response includes groupPagination.

userId
string[]

Filter workflows by one or more user IDs. Accepts repeated params, comma-separated values, or a JSON array.

channelId
string[]

Filter workflows by one or more notification channel IDs. Accepts repeated params, comma-separated values, or a JSON array.

monitoring
enum<string>

Filter workflows by monitoring status

Available options:
true,
false
updateInterval
enum<string>

Filter workflows by update interval. REAL_TIME matches workflows that run in real time, independent of notification configuration.

Available options:
HOURLY,
DAILY,
WEEKLY,
MONTHLY,
REAL_TIME
scheduleType
enum<string>

Filter workflows by schedule type. RUN_ONCE = no recurring schedule (Complete), RECURRING = has a recurring/real-time schedule (Scheduled).

Available options:
RUN_ONCE,
RECURRING
templateId
string[]

Filter to workflows instantiated from one or more template IDs. Accepts repeated params, comma-separated values, or a JSON array.

includeDeleted
enum<string>
default:false

Include deleted workflows (for compliance officers)

Available options:
true,
false
format
enum<string>
default:json

Response format (json or csv for export)

Available options:
json,
csv

Response

Successfully retrieved workflows

workflows
object[]

List of workflows

pagination
object

Pagination information

groupPagination
object

Per-group counts and window metadata. Present only when groupWindows is requested.