Get a list of workflows
Retrieves a list of workflows with pagination and search capabilities
Request
- Base URL: https://api.kadoa.com
- URL: https://api.kadoa.com/v4/workflows
- Auth: API key in header x-api-key
Query parameters
Search term to filter workflows by name or workflow ID
Number of items to skip
Maximum number of items to return
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.
Filter by the latest execution attempt. Use this for run diagnostics, not workflow status UI.
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.
Filter workflows by support status (has open support request)
Filter workflows by tags. Accepts repeated params, comma-separated values, or a JSON array.
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.
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.
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.
Filter workflows by one or more user IDs. Accepts repeated params, comma-separated values, or a JSON array.
Filter workflows by one or more notification channel IDs. Accepts repeated params, comma-separated values, or a JSON array.
Filter workflows by monitoring status
Filter workflows by update interval. REAL_TIME matches workflows that run in real time, independent of notification configuration.
Filter workflows by schedule type. RUN_ONCE = no recurring schedule (Complete), RECURRING = has a recurring/real-time schedule (Scheduled).
Filter to workflows instantiated from one or more template IDs. Accepts repeated params, comma-separated values, or a JSON array.
Include deleted workflows (for compliance officers)
Response format (json or csv for export)
Response
Successfully retrieved workflows
Changes
No recorded changes to this operation across all 1 revision of this API.