查询用户组接口

更新时间:
复制 MD 格式

所需权限

所需权限

资源

Scope

资源服务

用户组读取(读取)

user-groups

admin.v1.user-groups.read

qwenwork-biz-service

GET /api/openapi/v1/user-groups

公共请求头

适用《通过 API 配置 QwenWork 管理后台》的“认证与请求头”章节:Authorization 必填,X-Request-Id 可选;当前接口所需 Scope 见本页。

Idempotency-Key 是否适用及必填性以本页请求参数为准,不能用追踪标识替代幂等键。

请求参数

名称

位置

类型

必填

说明

示例

keyword

query

string

否

搜索关键词 maxLength=255

"<string>"

page

query

integer · int64

否

页码 minimum=1 default=1

1

page_size

query

integer · int64

否

每页条数 minimum=1 maximum=100 default=20

20

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。

curl --request GET \
  --url '<BASE_URL>/api/openapi/v1/user-groups?keyword=<keyword>&page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应状态表

HTTP 状态码

触发条件

响应结构引用

客户端处理建议

200

请求成功

见本文“响应结果”

读取响应结果。

default

未单独列出的认证、授权、校验或依赖错误

见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构

按状态与 code 处理;写操作重试前核实结果及幂等要求。

响应结果

Content-Type: application/json

名称

类型

必填

说明

示例

items

array<object> | null

是

用户组列表

-

page

integer · int64

是

页码

0

page_size

integer · int64

是

每页条数

0

total_items

integer · int64

是

总条数

0

total_pages

integer · int64

是

总页数

0

items[]

字段

类型

必填

说明

created_at

string · date-time

是

创建时间

department_count

integer · int64

是

包含的部门数量

description

string

是

说明

direct_user_count

integer · int64

是

直接加入的用户数量

id

string

是

用户组 ID

name

string

是

用户组名称

updated_at

string · date-time

是

更新时间

响应示例

{
  "items": [
    {
      "created_at": "2026-08-27T10:00:00Z",
      "department_count": 0,
      "description": "<string>",
      "direct_user_count": 0,
      "id": "<string>",
      "name": "<string>",
      "updated_at": "2026-08-27T10:00:00Z"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_items": 0,
  "total_pages": 0
}