Skip to main content

projects

Overview

Nameprojects
TypeResource
Idgithub.projects.projects

Fields

NameDatatypeDescription
idinteger
namestringName of the project
node_idstring
organization_permissionstringThe baseline permission that all organization members have on this project. Only present if owner is an organization.
created_atstring
owner_urlstring
html_urlstring
numberinteger
statestringState of the project; either 'open' or 'closed'
privatebooleanWhether or not this project can be seen by everyone. Only present if owner is an organization.
columns_urlstring
urlstring
updated_atstring
bodystringBody of the project
creatorobjectA GitHub user.

Methods

NameAccessible byRequired ParamsDescription
getSELECTproject_idGets 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.
list_for_orgSELECTorgLists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
list_for_repoSELECTowner, repoLists 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.
list_for_userSELECTusernameLists projects for a user.
create_for_authenticated_userINSERTdata__nameCreates a user project board. Returns a 410 Gone status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
create_for_orgINSERTorg, data__nameCreates an organization project board. Returns a 410 Gone status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
create_for_repoINSERTowner, repo, data__nameCreates a repository project board. Returns a 410 Gone status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
deleteDELETEproject_idDeletes a project board. Returns a 404 Not Found status if projects are disabled.
updateEXECproject_idUpdates 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.