GitHub v3 REST API

Update an existing project column

patch
{protocol}://{hostname}/api/v3/projects/columns/{column_id}

Path Parameters

column_idintegerrequired

column_id parameter

Body

application/json
namestringrequired

Name of the project column

Example:Remaining tasks

Response

application/json

Response

Project Column

Project columns contain cards of work.

urlstring(uri)required

Example:https://api.github.com/projects/columns/367

project_urlstring(uri)required

Example:https://api.github.com/projects/120

cards_urlstring(uri)required

Example:https://api.github.com/projects/columns/367/cards

idintegerrequired

The unique identifier of the project column

Example:42

node_idstringrequired

Example:MDEzOlByb2plY3RDb2x1bW4zNjc=

namestringrequired

Name of the project column

Example:Remaining tasks

created_atstring(date-time)required

Example:2016-09-05T14:18:44Z

updated_atstring(date-time)required

Example:2016-09-05T14:22:28Z

patch/projects/columns/{column_id}

Body

{ "name": "Remaining tasks" }
 
application/json

Delete a project column

delete
{protocol}://{hostname}/api/v3/projects/columns/{column_id}

Path Parameters

column_idintegerrequired

column_id parameter

Response

Response

delete/projects/columns/{column_id}
 

List project cards

get
{protocol}://{hostname}/api/v3/projects/columns/{column_id}/cards

Query Parameters

archived_statestring

Filters the project cards that are returned by the card’s state. Can be one of all,archived, or not_archived.

Allowed values:allarchivednot_archived

Default:not_archived

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

column_idintegerrequired

column_id parameter

Response

application/json

Response

Project cards represent a scope of work.

urlstring(uri)required

Example:https://api.github.com/projects/columns/cards/1478

idintegerrequired

The project card’s ID

Example:42

node_idstringrequired

Example:MDExOlByb2plY3RDYXJkMTQ3OA==

notestring | nullrequired

Example:Add payload for delete Project column

creatorobject | nullrequired

Simple User

Show Child Parameters
created_atstring(date-time)required

Example:2016-09-05T14:21:06Z

updated_atstring(date-time)required

Example:2016-09-05T14:20:22Z

archivedboolean

Whether or not the card is archived

Example:false

column_namestring
project_idstring
column_urlstring(uri)required

Example:https://api.github.com/projects/columns/367

content_urlstring(uri)

Example:https://api.github.com/repos/api-playground/projects-test/issues/3

project_urlstring(uri)required

Example:https://api.github.com/projects/120

get/projects/columns/{column_id}/cards
 
application/json

Create a project card

post
{protocol}://{hostname}/api/v3/projects/columns/{column_id}/cards

Path Parameters

column_idintegerrequired

column_id parameter

Body

application/json
One Of
notestring | nullrequired

The project card’s note

Example:Update all gems

Response

application/json

Response

Project Card

Project cards represent a scope of work.

urlstring(uri)required

Example:https://api.github.com/projects/columns/cards/1478

idintegerrequired

The project card’s ID

Example:42

node_idstringrequired

Example:MDExOlByb2plY3RDYXJkMTQ3OA==

notestring | nullrequired

Example:Add payload for delete Project column

creatorobject | nullrequired

Simple User

Show Child Parameters
created_atstring(date-time)required

Example:2016-09-05T14:21:06Z

updated_atstring(date-time)required

Example:2016-09-05T14:20:22Z

archivedboolean

Whether or not the card is archived

Example:false

column_namestring
project_idstring
column_urlstring(uri)required

Example:https://api.github.com/projects/columns/367

content_urlstring(uri)

Example:https://api.github.com/repos/api-playground/projects-test/issues/3

project_urlstring(uri)required

Example:https://api.github.com/projects/120

post/projects/columns/{column_id}/cards

Body

{ "note": "Update all gems" }
 
application/json

Move a project column

post
{protocol}://{hostname}/api/v3/projects/columns/{column_id}/moves

Path Parameters

column_idintegerrequired

column_id parameter

Body

application/json
positionstringrequired

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

Match pattern:^(?:first|last|after:\d+)$

Example:last

Response

application/json

Response

object
* Additional properties are NOT allowed.
post/projects/columns/{column_id}/moves

Body

{ "position": "last" }
 
application/json