获取单个看板详情¶

GET /api/v5/org/{owner}/kanban/{kanban_id}/detail

该接口用于获取指定组织下单个看板的详细信息，包括看板的ID、名称、描述、状态、可见性及更新时间等数据，便于用户查看和了解看板的具体配置与状态。

访问令牌支持说明¶

AtomGit 用户访问令牌（AtomGit user access tokens）

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	组织的路径（path/login）
`kanban_id`	path	integer	是	看板 ID

响应参数¶

字段	类型	必返	可为空	说明
`id`	string	是	否	看板 ID
`iid`	integer	否	是	项目 ID
`name`	string	是	否	看板名称
`description`	string	是	否	看板描述
`status`	integer	是	否	状态：`0` 正常、`1` 关闭
`visibility`	integer	是	否	可见性：`1` public、`2` private
`updatedAt`	string	否	是	更新时间

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 kanban_id 必须为数字"
}

401 未认证

{
  "error": "unauthorized",
  "message": "缺少或无效的访问令牌"
}

404 资源不存在

{
  "error": "not_found",
  "message": "看板或组织不存在"
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad Request）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not Found）
`429`	请求过于频繁（Too Many Requests）
`500`	系统内部错误（Internal Server Error）

请求示例¶

参数说明¶

<owner> 替换为组织路径名（企业、组织或个人的地址 path）； <kanban_id> 替换为看板 ID。

本接口允许匿名访问，无需携带访问令牌；如需访问私有看板，也可携带 AtomGit 用户访问令牌。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/org/<owner>/kanban/<kanban_id>/detail' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/org/<owner>/kanban/<kanban_id>/detail",
  {
    headers: {
      "Accept": "application/json",
    },
  }
);

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v5/org/<owner>/kanban/<kanban_id>/detail",
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "id": "1",
  "iid": 1,
  "name": "产品迭代看板",
  "description": "产品迭代任务跟踪",
  "status": 0,
  "visibility": 1,
  "updatedAt": "2026-10-14T05:09:53+08:00"
}

错误码¶

错误码	说明
`400`	参数错误或请求无法解析
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`403`	禁止访问
`404`	资源不存在
`429`	请求过于频繁，触发限流
`500`	系统内部错误

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc