Domain name for API request: databuddy.intl.tencentcloudapi.com.
This API is used to query the list of user groups in a workspace.
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: ListWorkspaceGroups. |
| 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. |
| WorkspaceId | Yes | String | Workspace ID |
| GroupIds.N | No | Array of String | Batch query by user group ID; user group ID can be obtained through the ListWorkspaceGroups API |
| GroupKeyword | No | String | Fuzzy matching by user group name |
| RoleIds.N | No | Array of String | Used to filter user groups associated with roles; can be obtained through the ListWorkspaceRoles API |
| OrderBys.N | No | Array of OrderBy | Multi-field sorting, for example, [{Name: 'CreateTime', Direction: 'Desc'}]; import one for single-field sorting. By default, sort in descending order by creation time. |
| PageNumber | No | Integer | Page number. Value range: starts from 1. Default value: 1. Values less than 1 are handled as 1. |
| PageSize | No | Integer | Size per page. Default: 10. Value range: [1,100]. Out-of-bounds values automatically converge to the boundary value. |
| GroupType | No | String | User group type filter criteria. The value is a string form of an enumerated numeric value: "0" = console system type (including all users), "1" = console custom type, "2" = workspace system type (including all workspace users), "3" = workspace custom type. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | ListWorkspaceGroupsRsp | Workspace user group 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: ListWorkspaceGroups
<Common request parameters>
{
"WorkspaceId": "17851563773633788",
"GroupKeyword": "example",
"RoleIds": [
"2001"
],
"PageNumber": 1,
"PageSize": 11,
"GroupType": "0"
}{
"Response": {
"Data": {
"Items": [
{
"CreateTime": "",
"GroupId": "700002164618",
"GroupName": "all_users",
"GroupType": "0",
"Roles": [],
"Tags": [],
"UpdateTime": "",
"UserCount": 0
}
],
"PageNumber": 0,
"PageSize": 0,
"TotalCount": 0,
"TotalPageNumber": 0
},
"RequestId": "a5c4fc49-defc-4230-b46f-36ce2d2a7168"
}
}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.
フィードバック