Skip to main content
REST API はバージョン管理になりました。 詳細については、「API のバージョン管理について」を参照してください。

Project (classic)列用 REST API エンドポイント

REST API を使って、プロジェクト (クラシック) で列を作成し、管理できます。

注:

  • これらのエンドポイントを使って操作されるのは、projects (classic) のみです。 Projects を管理するには、GraphQL API を使います。 詳しくは、「API を使用して Projects を管理する」を参照してください。
  • 新しい プロジェクト (クラシック) を作成するには、Organization、ユーザー、またはリポジトリに 1 つ以上の プロジェクト (クラシック) がある必要があります。

projects (classic) を管理する REST API は、personal access token (classic) を使った認証のみをサポートします。 詳しくは、「個人用アクセス トークンを管理する」を参照してください。

Get a project column

Gets information about a project column.

"Get a project column" のきめ細かいアクセス トークン

このエンドポイントは、次のトークンの種類で動作します:

トークンには、次のアクセス許可セットの少なくとも 1 つが必要です:

  • repository_projects:read
  • organization_projects:read

このエンドポイントは、パブリック リソースのみが要求される場合は、認証または前述メンションアクセス許可なしで使用できます。

"Get a project column" のパラメーター

ヘッダー
名前, Type, 説明
accept string

Setting to application/vnd.github+json is recommended.

パス パラメーター
名前, Type, 説明
column_id integer 必須

The unique identifier of the column.

"Get a project column" の HTTP 応答状態コード

状態コード説明
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

"Get a project column" のコード サンプル

要求の例

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

Response

Status: 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" }

Update an existing project column

"Update an existing project column" のきめ細かいアクセス トークン

このエンドポイントは、次のトークンの種類で動作します:

トークンには、次のアクセス許可セットの少なくとも 1 つが必要です:

  • repository_projects:write
  • organization_projects:write

"Update an existing project column" のパラメーター

ヘッダー
名前, Type, 説明
accept string

Setting to application/vnd.github+json is recommended.

パス パラメーター
名前, Type, 説明
column_id integer 必須

The unique identifier of the column.

本文のパラメーター
名前, Type, 説明
name string 必須

Name of the project column

"Update an existing project column" の HTTP 応答状態コード

状態コード説明
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

"Update an existing project column" のコード サンプル

要求の例

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"}'

Response

Status: 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" }

Delete a project column

Deletes a project column.

"Delete a project column" のきめ細かいアクセス トークン

このエンドポイントは、次のトークンの種類で動作します:

トークンには、次のアクセス許可セットの少なくとも 1 つが必要です:

  • repository_projects:write
  • organization_projects:write

"Delete a project column" のパラメーター

ヘッダー
名前, Type, 説明
accept string

Setting to application/vnd.github+json is recommended.

パス パラメーター
名前, Type, 説明
column_id integer 必須

The unique identifier of the column.

"Delete a project column" の HTTP 応答状態コード

状態コード説明
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

"Delete a project column" のコード サンプル

要求の例

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

Response

Status: 204

Move a project column

"Move a project column" のきめ細かいアクセス トークン

このエンドポイントは、次のトークンの種類で動作します:

トークンには、次のアクセス許可セットの少なくとも 1 つが必要です:

  • repository_projects:write
  • organization_projects:write

"Move a project column" のパラメーター

ヘッダー
名前, Type, 説明
accept string

Setting to application/vnd.github+json is recommended.

パス パラメーター
名前, Type, 説明
column_id integer 必須

The unique identifier of the column.

本文のパラメーター
名前, Type, 説明
position string 必須

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

"Move a project column" の HTTP 応答状態コード

状態コード説明
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

422

Validation failed, or the endpoint has been spammed.

"Move a project column" のコード サンプル

要求の例

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"}'

Response

List project columns

Lists the project columns in a project.

"List project columns" のきめ細かいアクセス トークン

このエンドポイントは、次のトークンの種類で動作します:

トークンには、次のアクセス許可セットの少なくとも 1 つが必要です:

  • repository_projects:read
  • organization_projects:read

このエンドポイントは、パブリック リソースのみが要求される場合は、認証または前述メンションアクセス許可なしで使用できます。

"List project columns" のパラメーター

ヘッダー
名前, Type, 説明
accept string

Setting to application/vnd.github+json is recommended.

パス パラメーター
名前, Type, 説明
project_id integer 必須

The unique identifier of the project.

クエリ パラメーター
名前, Type, 説明
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Default: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Default: 1

"List project columns" の HTTP 応答状態コード

状態コード説明
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

"List project columns" のコード サンプル

要求の例

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

Response

Status: 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" } ]

Create a project column

Creates a new project column.

"Create a project column" のきめ細かいアクセス トークン

このエンドポイントは、次のトークンの種類で動作します:

トークンには、次のアクセス許可セットの少なくとも 1 つが必要です:

  • repository_projects:write
  • organization_projects:write

"Create a project column" のパラメーター

ヘッダー
名前, Type, 説明
accept string

Setting to application/vnd.github+json is recommended.

パス パラメーター
名前, Type, 説明
project_id integer 必須

The unique identifier of the project.

本文のパラメーター
名前, Type, 説明
name string 必須

Name of the project column

"Create a project column" の HTTP 応答状態コード

状態コード説明
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

422

Validation failed, or the endpoint has been spammed.

"Create a project column" のコード サンプル

要求の例

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"}'

Response

Status: 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" }