读取组织信息接口

读取当前组织的基本信息,包括组织名称、Logo 地址和已验证的邮箱域名。组织身份由调用所用的 API Key 确定。

所需权限

所需权限资源Scope资源服务
组织信息读取(读取)organizationadmin.v1.organization.readqwenwork-biz-service

GET /api/openapi/v1/organization

认证与请求头

使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。

名称位置类型必填说明示例
Authorizationheaderstring应用 API Key,使用 Bearer 方式传递。Bearer qwk_\\*
X-Request-Idheaderstring可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

此接口没有额外请求参数。

请求示例

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

curl --request GET --url '<BASE_URL>/api/openapi/v1/organization' --header 'Authorization: Bearer <API_KEY>'

响应

200 请求成功,返回当前或更新后的数据。

名称类型必填说明示例
idstring此记录的唯一标识,查询、更新或删除对应记录时使用。"<string>"
logo_urlstring | null当前组织 Logo 的访问地址。"<string>"
namestring组织的名称。"<string>"
updated_atstring · date-time此记录最后一次更新的时间。"2026-08-27T10:00:00Z"
verified_email_domainsarray | null当前组织已验证的邮箱域名列表。["<string>"]
{
  "id": "<string>",
  "logo_url": "<string>",
  "name": "<string>",
  "updated_at": "2026-08-27T10:00:00Z",
  "verified_email_domains": [
    "<string>"
  ]
}

default 请求失败,返回错误码和错误详情。

名称类型必填说明示例
codestring用于程序判断错误原因的稳定业务错误码。"<string>"
detailstring便于阅读的错误说明。"<string>"
detailsOpenapiErrorDetails字段校验失败时的详细信息。{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstring未通过校验的请求字段。"<string>"
details.reasonstring稳定的校验失败原因,用于判断字段为何不合法。"<string>"
details.suggestionstring建议采用的规范化字段值。"<string>"
errorstring稳定的 HTTP 错误类型。"<string>"
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}