Skip to main content
O controle de versão da API REST já foi feito. Para obter mais informações, confira "Sobre o controle de versão da API".

Colunas de Project (classic)

Use a API REST para criar e gerenciar colunas em um projeto (clássico).

Observações:

  • Esses pontos de extremidade interagem apenas com o projects (classic). Para gerenciar o Projects, use a API do GraphQL. Para obter mais informações, confira "Usando a API para gerenciar Projects".
  • Para criar um novo projeto (clássico), a organização, usuário ou repositório já deve ter pelo menos um projeto (clássico).

A API REST para gerenciar projects (classic) só dá suporte à autenticação usando um personal access token (classic). Para obter mais informações, confira "Gerenciar seus tokens de acesso pessoal".

Get a project column

Gets information about a project column.

Tokens de acesso refinados para "Get a project column"

Esse ponto de extremidade funciona com os seguintes tipos de token:

O token deve ter pelo menos um dos seguintes conjuntos de permissões:

  • repository_projects:read
  • organization_projects:read

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "Get a project column"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
column_id integer Obrigatório

The unique identifier of the column.

Códigos de status de resposta HTTP para "Get a project column"

Código de statusDescrição
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

Exemplos de código para "Get a project column"

Exemplo de solicitação

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

Tokens de acesso refinados para "Update an existing project column"

Esse ponto de extremidade funciona com os seguintes tipos de token:

O token deve ter pelo menos um dos seguintes conjuntos de permissões:

  • repository_projects:write
  • organization_projects:write

Parâmetros para "Update an existing project column"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
column_id integer Obrigatório

The unique identifier of the column.

Parâmetros do corpo
Nome, Tipo, Descrição
name string Obrigatório

Name of the project column

Códigos de status de resposta HTTP para "Update an existing project column"

Código de statusDescrição
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

Exemplos de código para "Update an existing project column"

Exemplo de solicitação

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.

Tokens de acesso refinados para "Delete a project column"

Esse ponto de extremidade funciona com os seguintes tipos de token:

O token deve ter pelo menos um dos seguintes conjuntos de permissões:

  • repository_projects:write
  • organization_projects:write

Parâmetros para "Delete a project column"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
column_id integer Obrigatório

The unique identifier of the column.

Códigos de status de resposta HTTP para "Delete a project column"

Código de statusDescrição
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

Exemplos de código para "Delete a project column"

Exemplo de solicitação

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

Tokens de acesso refinados para "Move a project column"

Esse ponto de extremidade funciona com os seguintes tipos de token:

O token deve ter pelo menos um dos seguintes conjuntos de permissões:

  • repository_projects:write
  • organization_projects:write

Parâmetros para "Move a project column"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
column_id integer Obrigatório

The unique identifier of the column.

Parâmetros do corpo
Nome, Tipo, Descrição
position string Obrigatório

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

Códigos de status de resposta HTTP para "Move a project column"

Código de statusDescrição
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

422

Validation failed, or the endpoint has been spammed.

Exemplos de código para "Move a project column"

Exemplo de solicitação

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.

Tokens de acesso refinados para "List project columns"

Esse ponto de extremidade funciona com os seguintes tipos de token:

O token deve ter pelo menos um dos seguintes conjuntos de permissões:

  • repository_projects:read
  • organization_projects:read

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "List project columns"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
project_id integer Obrigatório

The unique identifier of the project.

Parâmetros de consulta
Nome, Tipo, Descrição
per_page integer

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

Padrão: 30

page integer

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

Padrão: 1

Códigos de status de resposta HTTP para "List project columns"

Código de statusDescrição
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

Exemplos de código para "List project columns"

Exemplo de solicitação

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.

Tokens de acesso refinados para "Create a project column"

Esse ponto de extremidade funciona com os seguintes tipos de token:

O token deve ter pelo menos um dos seguintes conjuntos de permissões:

  • repository_projects:write
  • organization_projects:write

Parâmetros para "Create a project column"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
project_id integer Obrigatório

The unique identifier of the project.

Parâmetros do corpo
Nome, Tipo, Descrição
name string Obrigatório

Name of the project column

Códigos de status de resposta HTTP para "Create a project column"

Código de statusDescrição
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

422

Validation failed, or the endpoint has been spammed.

Exemplos de código para "Create a project column"

Exemplo de solicitação

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