column_idintegerrequired
column_id parameter
Create a project card
post
{protocol}://{hostname}/api/v3/projects/columns/{column_id}/cards
Path Parameters
Body
application/json
Body
application/json
One Ofnotestring | nullrequired
The project card’s note
Example:Update all gems
Response
application/json
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
Path Parameters
Body
{}
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
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
application/json
Response
object
* Additional properties are NOT allowed.
post/projects/columns/{column_id}/moves
Path Parameters
Body
{
"position": "last"
}
application/json
Get a project
Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
get
{protocol}://{hostname}/api/v3/projects/{project_id}
Path Parameters
project_idintegerrequired
Response
application/json
Response
application/json
Response
Project
Projects are a way to organize columns and cards of work.
owner_urlstring(uri)required
Example:https://api.github.com/repos/api-playground/projects-test
urlstring(uri)required
Example:https://api.github.com/projects/1002604
html_urlstring(uri)required
Example:https://github.com/api-playground/projects-test/projects/12
columns_urlstring(uri)required
Example:https://api.github.com/projects/1002604/columns
idintegerrequired
Example:1002604
node_idstringrequired
Example:MDc6UHJvamVjdDEwMDI2MDQ=
namestringrequired
Name of the project
Example:Week One Sprint
bodystring | nullrequired
Body of the project
Example:This project represents the sprint of the first week in January
numberintegerrequired
Example:1
statestringrequired
State of the project; either ‘open’ or ‘closed’
Example:open
creatorobject | nullrequired
Simple User
Show Child Parameters
created_atstring(date-time)required
Example:2011-04-10T20:09:31Z
updated_atstring(date-time)required
Example:2014-03-03T18:58:10Z
organization_permissionstring
The baseline permission that all organization members have on this project. Only present if owner is an organization.
Allowed values:readwriteadminnone
privateboolean
Whether or not this project can be seen by everyone. Only present if owner is an organization.
get/projects/{project_id}
Path Parameters
application/json
Update a project
Updates a project board’s information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
patch
{protocol}://{hostname}/api/v3/projects/{project_id}
Path Parameters
project_idintegerrequired
Body
application/json
Body
application/json
namestring
Name of the project
Example:Week One Sprint
bodystring | null
Body of the project
Example:This project represents the sprint of the first week in January
statestring
State of the project; either ‘open’ or ‘closed’
Example:open
organization_permissionstring
The baseline permission that all organization members have on this project
Allowed values:readwriteadminnone
privateboolean
Whether or not this project can be seen by everyone.
Response
application/json
Response
application/json
Response
Project
Projects are a way to organize columns and cards of work.
owner_urlstring(uri)required
Example:https://api.github.com/repos/api-playground/projects-test
urlstring(uri)required
Example:https://api.github.com/projects/1002604
html_urlstring(uri)required
Example:https://github.com/api-playground/projects-test/projects/12
columns_urlstring(uri)required
Example:https://api.github.com/projects/1002604/columns
idintegerrequired
Example:1002604
node_idstringrequired
Example:MDc6UHJvamVjdDEwMDI2MDQ=
namestringrequired
Name of the project
Example:Week One Sprint
bodystring | nullrequired
Body of the project
Example:This project represents the sprint of the first week in January
numberintegerrequired
Example:1
statestringrequired
State of the project; either ‘open’ or ‘closed’
Example:open
creatorobject | nullrequired
Simple User
Show Child Parameters
created_atstring(date-time)required
Example:2011-04-10T20:09:31Z
updated_atstring(date-time)required
Example:2014-03-03T18:58:10Z
organization_permissionstring
The baseline permission that all organization members have on this project. Only present if owner is an organization.
Allowed values:readwriteadminnone
privateboolean
Whether or not this project can be seen by everyone. Only present if owner is an organization.
patch/projects/{project_id}
Path Parameters
Body
{}
application/json
Delete a project
Deletes a project board. Returns a 404 Not Found status if projects are disabled.
delete
{protocol}://{hostname}/api/v3/projects/{project_id}
Path Parameters
project_idintegerrequired
Response
Response
Delete Success
delete/projects/{project_id}