Skip to main content

读取组织信息接口

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

  • Scope：admin.v1.organization.read
  • 权限项：组织信息读取（organization）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/organization

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

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

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/organization' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
idstring是组织 ID"<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 Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}