ListWorkflows

Last updated:2025-11-13 20:54:47

ListWorkflows

Last updated: 2025-11-13 20:54:47

1. API Description

Domain name for API request: wedata.intl.tencentcloudapi.com.

This API is used to query the list of workflows.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ListWorkflows.
Version	Yes	String	Common Params. The value used for this API: 2025-08-06.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-hongkong, ap-jakarta, ap-singapore, eu-frankfurt, na-ashburn, na-siliconvalley.
ProjectId	Yes	String	Project ID.
PageNumber	No	Integer	Specifies the data page number of the request. default value is 1. valid values: equal to or greater than 1.
PageSize	No	Integer	Specifies the number of data records displayed per page. default: 10. value range: 10 to 200.
Keyword	No	String	Search keywords.
ParentFolderPath	No	String	Workflow folder.
WorkflowType	No	String	Workflow type. valid values: cycle and manual.
BundleId	No	String	bundleId item.
OwnerUin	No	String	Owner ID
CreateUserUin	No	String	Creator ID.
ModifyTime.N	No	Array of String	Modification time interval yyyy-MM-dd HH:MM:ss. fill in two times in the array.
CreateTime.N	No	Array of String	Creation time range yyyy-MM-dd HH:MM:ss. two times must be filled in the array.

3. Output Parameters

Parameter Name	Type	Description
Data	ListWorkflowInfo	Describes workflow pagination information.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Success

This example shows you how to successfully query the workflow list.

Input Example

POST / HTTP/1.1
Host: wedata.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListWorkflows
<Common request parameters>

{
    "ProjectId": "1470547050521227264"
}

Output Example

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "CreateTime": "2025-07-02 10:56:59",
                    "CreateUserUin": null,
                    "ModifyTime": "2025-08-20 14:15:31",
                    "OwnerUin": "100042571125",
                    "UpdateUserUin": "100042571125",
                    "WorkflowDesc": "",
                    "WorkflowId": "a603bf20-6757-4401-85ee-3b1da69a4cbf",
                    "WorkflowName": "0001delete",
                    "WorkflowType": "cycle"
                }
            ],
            "PageNumber": 1,
            "PageSize": 10,
            "TotalCount": 573,
            "TotalPageNumber": 58
        },
        "RequestId": "ec509774-00a6-46d2-a752-c133bcb2aeb1"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
AuthFailure	CAM signature/authentication error.
FailedOperation	Operation failed.
InvalidParameter	Parameter error.
InvalidParameterValue	Parameter value error.
MissingParameter	Parameter missing.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud