Get the Workflow Task List

Use this API to retrieve a paginated list of NineData workflow tasks. Filter the results by task type, data source, user perspective, status, and time range.

Request URL: /openapi/v1/workflow/list

HTTP method: GET

Request parameters

Parameter	Type	Required	Description	Example
module	String	Yes	Task type: sqlTask: SQL task dataExport: Data export	sqlTask
datasourceId	String	No	Data source ID.	ds-dbiddumxp4h
accountId	String	No	User ID.	1238779494193071
accountType	String	No	User perspective: submitter: Submitted by me toApprove: Pending my approval toExecute: Pending my execution executed: Executed approved: Approved	submitter
status	String	No	Task status: notStarted: Not started preChecking: Pre-checking preCheckSkip: Pre-check skipped preCheckSuccess: Pre-check passed preCheckFailed: Pre-check failed ruleChecking: Rule checking ruleCheckSuccess: Rule check passed ruleCheckFailed: Rule check failed toApprove: Pending approval approved: Approval passed approveRejected: Approval rejected running: Running waiting: Waiting for scheduling scheduling: Scheduling suspended: Suspended stopped: Terminated success: Successful failed: Failed finished: Finished canceled: Withdrawn executeCanceled: Execution canceled skipped: Skipped	notStarted
keyword	String	No	Keyword matching the task name or task ID.	test
startTime	String	No	Start of the task creation time range, in the format yyyy-MM-dd'T'HH:mm:ssZ.	2022-09-11T12:34:56Z
endTime	String	No	End of the task creation time range, in the format yyyy-MM-dd'T'HH:mm:ssZ.	2022-09-11T12:34:56Z
current	Integer	Yes	Page number, starting from 1. Default: 1.	1
pageSize	Integer	Yes	Number of items per page. Default: 10.	10

Response parameters

Parameter	Type	Description	Example
success	Boolean	Whether the request was successful.	true
data	Array	List of workflow tasks.	N/A
└name	String	Task name.	"test task"
└workflowId	String	Task ID.	"st-d5e200daj7wk"
└createTime	String	Task creation time.	"2022-09-11T12:34:56Z"
└module	String	Task type.	sqlTask
└submitter	String	ID of the user who submitted the task.	"1238779494193071"
└status	String	Task status.	notStarted
└datasourceId	String	ID of the associated data source.	"ds-dbiddumxp4h"
└dbGroupId	String	ID of the associated database group.	"group1"
└dbName	String	Name of the associated database.	"ght"
└schemaName	String	Name of the associated schema.	"public"
errorCode	String	Error code.	N/A
message	String	Error message.	N/A
current	Integer	Current page number.	1
pageSize	Integer	Number of items per page.	10
total	Integer	Total number of records.	100

Successful response example

{
    "success": true,
    "requestId": "Gq7t6KXM-hnmhpRInhiga9BTdghm8OSI",
    "data": [{
        "createTime": "2025-10-22 07:15:50Z",
        "workflowId": "st-ddonzxko8kaz",
        "name": "Test quick execution",
        "module": "sqlTask",
        "submitter": "1030799091781335",
        "status": "success",
        "datasourceId": "ds-ddduea45j638",
        "dbName": "ght"
    }, {
        "createTime": "2025-10-22 07:15:27Z",
        "workflowId": "st-ddonzmqbjtua",
        "name": "Test quick execution",
        "module": "sqlTask",
        "submitter": "1030799091781335",
        "status": "failed",
        "datasourceId": "ds-ddduea45j638",
        "dbName": "ght"
    }],
    "current": 1,
    "pageSize": 10,
    "total": 30
}