REST API 现在已版本化。 更多信息，请参阅“关于 API 版本控制”。

项目（经典版）列的 REST API 端点

使用 REST API 创建和管理项目（经典版）中的列。

注意

项目（经典版）已被移除。您可以在GitHub 博客上阅读有关此更改的更多信息。

新的改进型项目体验现已推出。更多信息，请参阅“关于项目”。

这些端点仅与项目（经典版）交互。要管理项目，请使用 GraphQL API。更多信息，请参阅“使用 API 管理项目”。

管理项目（经典版）的 REST API 仅支持使用个人访问令牌（经典版）进行身份验证。更多信息，请参阅“管理您的个人访问令牌”。

获取项目列

获取有关项目列的信息。

“获取项目列”的细粒度访问令牌

此端点与以下细粒度令牌类型一起使用:

细粒度令牌必须至少具有以下权限集之一

  • “项目”代码仓库权限（读取）
  • “项目”组织权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

“获取项目列”的参数

Headers
accept string

建议设置为application/vnd.github+json。

路径参数
column_id integer 必填

列的唯一标识符。

“获取项目列”的 HTTP 响应状态代码

状态代码描述
200

OK

304

未修改

401

需要身份验证

403

禁止

404

资源未找到

“获取项目列”的代码示例

请求示例

get/projects/columns/{column_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/projects/columns/COLUMN_ID

响应

状态：200
{ "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" }

更新现有项目列

“更新现有项目列”的细粒度访问令牌

此端点与以下细粒度令牌类型一起使用:

细粒度令牌必须至少具有以下权限集之一

  • “项目”代码仓库权限（写入）
  • “项目”组织权限（写入）

“更新现有项目列”的参数

Headers
accept string

建议设置为application/vnd.github+json。

路径参数
column_id integer 必填

列的唯一标识符。

主体参数
name string 必填

项目列的名称

“更新现有项目列”的 HTTP 响应状态代码

状态代码描述
200

OK

304

未修改

401

需要身份验证

403

禁止

“更新现有项目列”的代码示例

请求示例

patch/projects/columns/{column_id}
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/projects/columns/COLUMN_ID \ -d '{"name":"To Do"}'

响应

状态：200
{ "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" }

删除项目列

删除项目列。

“删除项目列”的细粒度访问令牌

此端点与以下细粒度令牌类型一起使用:

细粒度令牌必须至少具有以下权限集之一

  • “项目”代码仓库权限（写入）
  • “项目”组织权限（写入）

“删除项目列”的参数

Headers
accept string

建议设置为application/vnd.github+json。

路径参数
column_id integer 必填

列的唯一标识符。

“删除项目列”的 HTTP 响应状态代码

状态代码描述
204

无内容

304

未修改

401

需要身份验证

403

禁止

“删除项目列”的代码示例

请求示例

delete/projects/columns/{column_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/projects/columns/COLUMN_ID

响应

状态：204

移动项目列

“移动项目列”的细粒度访问令牌

此端点与以下细粒度令牌类型一起使用:

细粒度令牌必须至少具有以下权限集之一

  • “项目”代码仓库权限（写入）
  • “项目”组织权限（写入）

“移动项目列”的参数

Headers
accept string

建议设置为application/vnd.github+json。

路径参数
column_id integer 必填

列的唯一标识符。

主体参数
position string 必填

项目中列的位置。可以是以下之一：first、last 或 after:<column_id>，以将其放在指定列之后。

“移动项目列”的 HTTP 响应状态代码

状态代码描述
201

已创建

304

未修改

401

需要身份验证

403

禁止

422

验证失败，或端点已被滥用。

“移动项目列”的代码示例

请求示例

post/projects/columns/{column_id}/moves
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/projects/columns/COLUMN_ID/moves \ -d '{"position":"last"}'

响应

状态：201

列出项目列

列出项目中的项目列。

“列出项目列”的细粒度访问令牌

此端点与以下细粒度令牌类型一起使用:

细粒度令牌必须至少具有以下权限集之一

  • “项目”代码仓库权限（读取）
  • “项目”组织权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

“列出项目列”的参数

Headers
accept string

建议设置为application/vnd.github+json。

路径参数
project_id integer 必填

项目的唯一标识符。

查询参数
per_page integer

每页的结果数（最大 100）。更多信息，请参阅“在 REST API 中使用分页”。

默认值： 30

page integer

要获取的结果页码。更多信息，请参见“REST API 中使用分页”。

默认值：1

“列出项目列”的HTTP响应状态码

状态代码描述
200

OK

304

未修改

401

需要身份验证

403

禁止

“列出项目列”的代码示例

请求示例

get/projects/{project_id}/columns
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/projects/PROJECT_ID/columns

响应

状态：200
[ { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" } ]

创建项目列

创建一个新的项目列。

“创建项目列”的细粒度访问令牌

此端点与以下细粒度令牌类型一起使用:

细粒度令牌必须至少具有以下权限集之一

  • “项目”代码仓库权限（写入）
  • “项目”组织权限（写入）

“创建项目列”的参数

Headers
accept string

建议设置为application/vnd.github+json。

路径参数
project_id integer 必填

项目的唯一标识符。

主体参数
name string 必填

项目列的名称

“创建项目列”的HTTP响应状态码

状态代码描述
201

已创建

304

未修改

401

需要身份验证

403

禁止

422

验证失败，或端点已被滥用。

“创建项目列”的代码示例

请求示例

post/projects/{project_id}/columns
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/projects/PROJECT_ID/columns \ -d '{"name":"Remaining tasks"}'

响应

状态：201
{ "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" }