project_idintegerrequired
usernamestringrequired
Remove user as a collaborator
Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.
delete
{protocol}://{hostname}/api/v3/projects/{project_id}/collaborators/{username}
Path Parameters
Response
Response
Response
delete/projects/{project_id}/collaborators/{username}
Path Parameters
Get project permission for a user
Returns the collaborator’s permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user’s permission level.
get
{protocol}://{hostname}/api/v3/projects/{project_id}/collaborators/{username}/permission
Path Parameters
project_idintegerrequired
usernamestringrequired
Response
application/json
Response
application/json
Response
Project Collaborator Permission
Project Collaborator Permission
permissionstringrequired
userobject | nullrequired
Simple User
Show Child Parameters
get/projects/{project_id}/collaborators/{username}/permission
Path Parameters
application/json
List project columns
get
{protocol}://{hostname}/api/v3/projects/{project_id}/columns
Query Parameters
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
project_idintegerrequired
Response
application/json
Response
application/json
Response
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
get/projects/{project_id}/columns
Path Parameters
Query Parameters
application/json
Create a project column
post
{protocol}://{hostname}/api/v3/projects/{project_id}/columns
Path Parameters
project_idintegerrequired
Body
application/json
Body
application/json
namestringrequired
Name of the project column
Example:Remaining tasks
Response
application/json
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
post/projects/{project_id}/columns
Path Parameters
Body
{
"name": "Remaining tasks"
}
application/json
List repository projects
Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. 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/repos/{owner}/{repo}/projects
Query Parameters
statestring
Indicates the state of the projects to return. Can be either open, closed, or all.
Allowed values:openclosedall
Default:open
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
ownerstringrequired
repostringrequired
Response
application/json
Response
application/json
Response
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/repos/{owner}/{repo}/projects
Path Parameters
Query Parameters
application/json