list_workflows
Retrieve workflows from DBOS Conductor with optional filters by status, time, user, or queue. Use to inspect workflow history and debug application issues.
Instructions
List workflows from DBOS Conductor with optional filters.
Args: application_name (string, required): Name of the DBOS application workflow_uuids (array of strings, optional): Filter to only these specific workflow IDs workflow_name (string or array of strings, optional): Filter by workflow function name authenticated_user (string or array of strings, optional): Filter by the user who started the workflow start_time (string, optional): Filter workflows created after this time (ISO 8601) end_time (string, optional): Filter workflows created before this time (ISO 8601) completed_after (string, optional): Filter workflows completed after this time (ISO 8601) completed_before (string, optional): Filter workflows completed before this time (ISO 8601) dequeued_after (string, optional): Filter workflows dequeued after this time (ISO 8601) dequeued_before (string, optional): Filter workflows dequeued before this time (ISO 8601) status (string or array of strings, optional): Filter by status - PENDING, SUCCESS, ERROR, CANCELLED, ENQUEUED, DELAYED, or MAX_RECOVERY_ATTEMPTS_EXCEEDED application_version (string or array of strings, optional): Filter by application version forked_from (string or array of strings, optional): Filter to workflows forked from this workflow ID parent_workflow_id (string or array of strings, optional): Filter to child workflows of this parent workflow ID queue_name (string or array of strings, optional): Filter by workflow queue name limit (int, optional): Maximum number of workflows to return offset (int, optional): Number of workflows to skip (for pagination) sort_desc (bool, optional): Sort by creation time descending (default: false, ascending) workflow_id_prefix (string or array of strings, optional): Filter to workflow IDs starting with this prefix load_input (bool, optional): Include workflow input data in response (default: false; always false for private-mode applications) load_output (bool, optional): Include workflow output data in response (default: false; always false for private-mode applications) executor_id (string or array of strings, optional): Filter by executor ID running the workflow queues_only (bool, optional): Only return workflows that are on a queue (default: false) was_forked_from (bool, optional): If true, only return forked workflows. If false, only return non-forked workflows. has_parent (bool, optional): If true, only return child workflows. If false, only return workflows without a parent.
Returns: workflows: Array of workflow objects, each containing: - WorkflowUUID (string): The workflow ID - Status (string): PENDING, SUCCESS, ERROR, CANCELLED, ENQUEUED, DELAYED, or MAX_RECOVERY_ATTEMPTS_EXCEEDED - WorkflowName (string): The name of the workflow function - WorkflowClassName (string, optional): The name of the workflow's class, if any - WorkflowConfigName (string, optional): The name with which the workflow's class instance was configured, if any - AuthenticatedUser (string, optional): The user who ran the workflow, if specified - AssumedRole (string, optional): The role with which the workflow ran, if specified - AuthenticatedRoles (string, optional): All roles which the authenticated user could assume (JSON array) - Input (string, optional): The workflow input (JSON string, only if load_input=true) - Output (string, optional): The workflow's output, if any (JSON string, only if load_output=true) - Error (string, optional): The error the workflow threw, if any - CreatedAt (string): Workflow start time as Unix epoch milliseconds - UpdatedAt (string): Last time the workflow status was updated as Unix epoch milliseconds - QueueName (string, optional): If this workflow was enqueued, on which queue - ApplicationVersion (string): The application version on which this workflow was started - ExecutorID (string, optional): The executor to most recently execute this workflow - WorkflowTimeoutMS (string, optional): The start-to-close timeout of the workflow in ms - WorkflowDeadlineEpochMS (string, optional): The deadline of the workflow, computed by adding its timeout to its start time (epoch ms) - DeduplicationID (string, optional): Unique ID for deduplication on a queue - Priority (string, optional): Priority of the workflow on the queue (1-2147483647, lower is higher priority) - QueuePartitionKey (string, optional): If this workflow is enqueued on a partitioned queue, its partition key - ForkedFrom (string, optional): If this workflow was forked from another, that workflow's ID - ParentWorkflowID (string, optional): If this is a child workflow, the ID of the parent workflow that started it - DequeuedAt (string, optional): When this workflow was dequeued from its queue (Unix epoch milliseconds) - WasForkedFrom (bool): Whether this workflow was forked from another workflow - DelayUntilEpochMS (string, optional): If this workflow has a delayed start, the epoch ms timestamp until which it is delayed - CompletedAt (string, optional): When this workflow completed (Unix epoch milliseconds) count (int): Number of workflows returned application (string): Name of the application queried
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| status | No | ||
| end_time | No | ||
| sort_desc | No | ||
| has_parent | No | ||
| load_input | No | ||
| queue_name | No | ||
| start_time | No | ||
| executor_id | No | ||
| forked_from | No | ||
| load_output | No | ||
| queues_only | No | ||
| workflow_name | No | ||
| dequeued_after | No | ||
| workflow_uuids | No | ||
| completed_after | No | ||
| dequeued_before | No | ||
| was_forked_from | No | ||
| application_name | Yes | ||
| completed_before | No | ||
| authenticated_user | No | ||
| parent_workflow_id | No | ||
| workflow_id_prefix | No | ||
| application_version | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||