Domain name for API request: databuddy.intl.tencentcloudapi.com.
Queries the workspace list.
A maximum of 20 requests can be initiated per second for this API.
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: ListWorkspaces. |
| Version | Yes | String | Common Params. The value used for this API: 2026-07-15. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore. |
| WorkspaceId | No | String | Workspace ID exact match |
| WorkspaceKeyword | No | String | Fuzzy matching by workspace name |
| StatusList.N | No | Array of Integer | Workspace status filtering (multiple selection): 0=not specified 1=creating 2=creation failure 3=operating normally 4=deleted |
| OrderBys.N | No | Array of OrderBy | Multi-field sorting, for example, [{Name: 'CreateTime', Direction: 'Desc'}]; import one for single-field sorting. Default: in descending order by creation time. |
| PageNumber | No | Integer | Page number. Value range: starts from 1. Default value: 1. |
| PageSize | No | Integer | Size per page. Default: 10. Minimum: 10. Maximum: 100 |
| WorkspaceRegion.N | No | Array of String | Workspace region filtering (multiple selection), for example, ap-guangzhou |
| Creator.N | No | Array of String | Creator UIN filter (multi-option) |
| Parameter Name | Type | Description |
|---|---|---|
| Data | ListWorkspacesRsp | Workspace list. |
| 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. |
POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListWorkspaces
<Common request parameters>
{
"WorkspaceId": "17676143448574812",
"WorkspaceKeyword": "example",
"StatusList": [
1
],
"PageNumber": 1,
"PageSize": 11
}{
"Response": {
"Data": {
"Items": [],
"PageNumber": 1,
"PageSize": 11,
"TotalCount": 0,
"TotalPageNumber": 0
},
"RequestId": "53f42163-04ec-4854-bb90-ce71f730e43e"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback