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

项目（经典）卡片的 REST API 端点

使用 REST API 在项目（经典）上创建和管理卡片。

注意

现在已禁用创建新的项目（经典）。项目（经典）将在 2024 年 8 月 23 日停用并删除。您可以在 GitHub 博客 上阅读有关此更改的更多信息。

新的改进的项目体验现已推出。有关更多信息，请参阅 "关于项目."

2024 年 8 月 23 日，所有剩余的项目（经典）将在功能删除之前自动迁移。

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

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

获取项目卡片

获取有关项目卡片的信息。

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

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

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

  • “项目”存储库权限（读取）
  • “项目”组织权限（读取）

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

“获取项目卡片”的参数

标头
accept string

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

路径参数
card_id integer 必需

卡片的唯一标识符。

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

状态代码描述
200

OK

304

未修改

401

需要身份验证

403

禁止

404

资源未找到

“获取项目卡片”的代码示例

请求示例

get/projects/columns/cards/{card_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/cards/CARD_ID

响应

状态：200
{ "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "添加删除项目列的有效载荷", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" }

更新现有项目卡片

用于“更新现有项目卡片”的细粒度访问令牌

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

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

  • “项目”存储库权限（写入）
  • “项目”组织权限（写入）

用于“更新现有项目卡片”的参数

标头
accept string

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

路径参数
card_id integer 必需

卡片的唯一标识符。

主体参数
note 字符串或空

项目卡片的备注

archived 布尔值

卡片是否已归档

用于“更新现有项目卡片”的 HTTP 响应状态码

状态代码描述
200

OK

304

未修改

401

需要身份验证

403

禁止

404

资源未找到

422

验证失败，或端点已被垃圾邮件攻击。

用于“更新现有项目卡片”的代码示例

请求示例

补丁/projects/columns/cards/{card_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/cards/CARD_ID \ -d '{"note":"添加删除项目列的有效载荷"}'

响应

状态：200
{ "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "添加删除项目列的有效载荷", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" }

删除项目卡片

删除项目卡片

用于“删除项目卡片”的细粒度访问令牌

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

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

  • “项目”存储库权限（写入）
  • “项目”组织权限（写入）

用于“删除项目卡片”的参数

标头
accept string

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

路径参数
card_id integer 必需

卡片的唯一标识符。

用于“删除项目卡片”的 HTTP 响应状态码

状态代码描述
204

无内容

304

未修改

401

需要身份验证

403

禁止

404

资源未找到

用于“删除项目卡片”的代码示例

请求示例

删除/projects/columns/cards/{card_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/cards/CARD_ID

响应

状态: 204

移动项目卡片

用于“移动项目卡片”的细粒度访问令牌

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

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

  • “项目”存储库权限（写入）
  • “项目”组织权限（写入）

用于“移动项目卡片”的参数

标头
accept string

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

路径参数
card_id integer 必需

卡片的唯一标识符。

主体参数
position 字符串 必需

卡片在列中的位置。可以是以下之一：top、bottom 或 after:<card_id>，以将卡片放置在指定卡片之后。

column_id 整数

要将卡片移动到的列的唯一标识符

用于“移动项目卡片”的 HTTP 响应状态代码

状态代码描述
201

已创建

304

未修改

401

需要身份验证

403

禁止

422

验证失败，或端点已被垃圾邮件攻击。

503

服务不可用

用于“移动项目卡片”的代码示例

请求示例

发布/projects/columns/cards/{card_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/cards/CARD_ID/moves \ -d '{"column_id":42,"position":"bottom"}'

响应

状态: 201

列出项目卡片

列出项目中的项目卡片。

用于“列出项目卡片”的细粒度访问令牌

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

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

  • “项目”存储库权限（读取）
  • “项目”组织权限（读取）

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

用于“列出项目卡片”的参数

标头
accept string

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

路径参数
column_id 整数 必需

列的唯一标识符。

查询参数
archived_state 字符串

根据卡片状态筛选返回的项目卡片。

默认: not_archived

可以是以下之一: all, archived, not_archived

per_page 整数

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

默认: 30

page 整数

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

默认: 1

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

状态代码描述
200

OK

304

未修改

401

需要身份验证

403

禁止

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

请求示例

get/projects/columns/{column_id}/cards
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/cards

响应

状态：200
[ { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "Add payload for delete Project column", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" } ]

创建项目卡片

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

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

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

  • “项目”存储库权限（写入）
  • “项目”组织权限（写入）

“创建项目卡片”的参数

标头
accept string

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

路径参数
column_id 整数 必需

列的唯一标识符。

主体参数
note 字符串或空值 必需

项目卡片的备注

content_id 整数 必需

与卡片关联的内容的唯一标识符

content_type 字符串 必需

与卡片关联的内容

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

状态代码描述
201

已创建

304

未修改

401

需要身份验证

403

禁止

422

验证失败

503

服务不可用

“创建项目卡片”的代码示例

请求示例

post/projects/columns/{column_id}/cards
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/cards \ -d '{"note":"Add payload for delete Project column"}'

响应

状态: 201
{ "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "添加删除项目列的有效载荷", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" }