获取组织看板列表¶

GET /api/v5/org/{owner}/kanban/list

该接口用于获取指定组织下的看板列表，支持按状态、可见性筛选及按名称搜索，并可按最新或最老排序、分页返回，同时提供看板总数及正常、关闭状态的看板数量统计。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	组织的路径
`status`	query	integer	否	状态，`0`：正常，`1`：关闭；默认不传为全部
`sort`	query	string	否	排序方式，`newest`：最新，`oldest`：最老
`visibility`	query	integer	否	可见性，`1`：公开的，`2`：私密的
`search`	query	string	否	按照名称搜索
`page`	query	string	否	当前页码
`per_page`	query	string	否	每页数量

响应参数¶

字段	类型	必返	可为空	说明
`close_count`	integer	是	否	已关闭的看板数量
`open_count`	integer	是	否	正常状态的看板数量
`all_count`	integer	是	否	看板总数
`content`	array	是	否	看板列表

content 对象

字段	类型	必返	可为空	说明
`content.id`	string	是	否	看板 ID
`content.iid`	integer	是	否	看板编号
`content.name`	string	是	否	看板名称
`content.description`	string	是	否	看板描述
`content.status`	integer	是	否	状态，`0`：正常，`1`：关闭
`content.visibility`	integer	是	否	可见性，`1`：公开的，`2`：私密的
`content.updated_at`	string	是	否	更新时间

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "参数错误"
}

401 未认证

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

Note: 错误字段名以后端实际返回为准。

HTTP 响应状态码¶

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

请求示例¶

参数说明¶

<owner> 替换为组织的路径（企业、组织或个人的地址 path）；该接口允许匿名访问，也可携带 AtomGit 用户访问令牌（追加 ?access_token=<token>）。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/org/<owner>/kanban/list?status=0&sort=newest&visibility=1&page=1&per_page=20' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const owner = "<owner>";
const params = new URLSearchParams({
  status: "0",
  sort: "newest",
  visibility: "1",
  page: "1",
  per_page: "20",
});

const response = await fetch(`https://api.atomgit.com/api/v5/org/${owner}/kanban/list?${params}`, {
  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/list",
    params={
        "status": 0,
        "sort": "newest",
        "visibility": 1,
        "page": 1,
        "per_page": 20,
    },
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "close_count": 0,
  "open_count": 0,
  "all_count": 0,
  "content": [
    {
      "id": "string",
      "iid": 0,
      "name": "string",
      "description": "string",
      "status": 0,
      "visibility": 0,
      "updated_at": "string"
    }
  ]
}

错误码¶

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

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