Domain name for API request: databuddy.intl.tencentcloudapi.com.
Queries the list of users 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: ListWorkspaceUsers. |
| 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 |
| UserKeyword | No | String | Fuzzy matching between username or UIN |
| RoleIds.N | No | Array of String | Role ID list, filter users associated with roles; can be obtained through the ListWorkspaceRoles API |
| UserUins.N | No | Array of String | User UIN list, precise filtering by UIN |
| OrderBys.N | No | Array of OrderBy | Sorting field list, 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. Default value: 1. Value range: starts from 1. Values less than 1 are handled as 1. |
| PageSize | No | Integer | Entries per page. Default: 10. Value range: [1,100]. Out-of-bounds values automatically converge to the boundary value. |
| ExtendInfo | No | String | Extended information (empty for the first request; for pagination requests, carry the ExtendInfo from the response. Used for locating the next offset in scenarios such as consecutive pagination and item permission filtering) |
| Parameter Name | Type | Description |
|---|---|---|
| Data | ListWorkspaceUsersRsp | Response to querying the list of users in a workspace |
| 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: ListWorkspaceUsers
<Common request parameters>
{
"WorkspaceId": "17841832994128461",
"RoleIds": [
"3001"
]
}{
"Response": {
"Data": {
"Items": [
{
"CreateTime": "1784183299474",
"IsAdmin": false,
"IsOwner": true,
"Nickname": "wedata30-dev@tencent.com",
"Roles": [
{
"Description": "",
"DisplayName": "",
"GroupNames": [],
"Id": "3001",
"Name": "Workspace Manager",
"RoleType": "",
"Source": 1
}
],
"Tags": [],
"UpdateTime": "1784183299474",
"UserName": "wedata30-dev@tencent.com",
"UserSource": "user",
"UserTag": 0,
"UserUin": "700002164618"
}
],
"PageNumber": 1,
"PageSize": 1,
"TotalCount": 1,
"TotalPageNumber": 1
},
"RequestId": "77d65215-c743-478c-82f5-dbc14286668f"
}
}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.
文档反馈