Workflows

Get a list of workflows

Retrieves a list of workflows with pagination and search capabilities

get/v4/workflows

Request

  • Base URL: https://api.kadoa.com
  • URL: https://api.kadoa.com/v4/workflows
  • Auth: API key in header x-api-key

Query parameters

searchstring

Search term to filter workflows by name or workflow ID

skipinteger

Number of items to skip

limitinteger

Maximum number of items to return

state'ACTIVE' | 'DRAFT' | 'PAUSED' | 'PREVIEW' | 'QUEUED' | 'SETUP' | 'COMPLIANCE_REVIEW' | 'COMPLIANCE_REJECTED' | 'NOT_SUPPORTED' | 'ERROR' | 'DELETED'

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.

runState'FAILED' | 'FINISHED' | 'RUNNING' | 'STOPPED'

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

displayState'ACTIVE' | 'DRAFT' | 'PAUSED' | 'PREVIEW' | 'FAILED' | 'RUNNING' | 'VALIDATING' | 'PENDING_START' | 'COMPLIANCE_REVIEW' | 'COMPLIANCE_REJECTED'

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.

inSupportstring

Filter workflows by support status (has open support request)

tagsstring[]

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

statusFiltersstring[]

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.

view'dashboard'

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.

groupWindowsstring

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. Besides the status groups, the "pinned" group holds the workflows the requesting user pinned, whatever their status.

userIdstring[]

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

channelIdstring[]

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

monitoring'true' | 'false'

Filter workflows by monitoring status

updateInterval'HOURLY' | 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'REAL_TIME'

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

scheduleType'RUN_ONCE' | 'RECURRING'

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

templateIdstring[]

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

includeDeletedstring

Include deleted workflows (for compliance officers)

format'json' | 'csv'

Response format (json or csv for export)

Response

Successfully retrieved workflows

groupPaginationobject

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

Changes

No recorded changes to this operation across all 1 revision of this API.