身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
您的组织 ID 应填在此处
此端点直接在 URL 中接受您的组织 ID,即 orgId。请将其替换到路径中——没有其他标头或查询参数可以替代此操作。
您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Returns a single organization the principal can access. RLS-scoped.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
orgId (path) | Uuid | 是 | Organization ID (UUIDv7). |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
type | OrgType | 是 | Organization type in the tenancy tree. |
parent_org_id | Uuid | null | 否 | Parent in the tenancy tree; null for a top-level org. |
name | string | 是 | — |
brand_id | object | 否 | White-label brand applied to this org's surfaces. |
default_currency | CurrencyCode | 是 | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
status | string<active, suspended, closed> | 是 | — |
created_at | string | 是 | — |
此端点可能返回的错误
401 · 403 · 404 · 429