project_idintegerrequired
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
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}
Path Parameters
List project collaborators
Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.
get
{protocol}://{hostname}/api/v3/projects/{project_id}/collaborators
Query Parameters
affiliationstring
Filters the collaborators by their affiliation. Can be one of:
* outside: Outside collaborators of a project that are not a member of the project’s organization.
* direct: Collaborators with permissions to a project, regardless of organization membership status.
* all: All collaborators the authenticated user can see.
Allowed values:outsidedirectall
Default:all
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
Simple User
namestring | null
emailstring | null
loginstringrequired
Example:octocat
idintegerrequired
Example:1
node_idstringrequired
Example:MDQ6VXNlcjE=
avatar_urlstring(uri)required
Example:https://github.com/images/error/octocat_happy.gif
gravatar_idstring | nullrequired
Example:41d064eb2195891e12d0413f63227ea7
urlstring(uri)required
Example:https://api.github.com/users/octocat
html_urlstring(uri)required
Example:https://github.com/octocat
followers_urlstring(uri)required
Example:https://api.github.com/users/octocat/followers
following_urlstringrequired
Example:https://api.github.com/users/octocat/following{/other_user}
gists_urlstringrequired
Example:https://api.github.com/users/octocat/gists{/gist_id}
starred_urlstringrequired
Example:https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_urlstring(uri)required
Example:https://api.github.com/users/octocat/subscriptions
organizations_urlstring(uri)required
Example:https://api.github.com/users/octocat/orgs
repos_urlstring(uri)required
Example:https://api.github.com/users/octocat/repos
events_urlstringrequired
Example:https://api.github.com/users/octocat/events{/privacy}
received_events_urlstring(uri)required
Example:https://api.github.com/users/octocat/received_events
typestringrequired
Example:User
site_adminbooleanrequired
starred_atstring
Example:"2020-07-09T00:17:55Z"
get/projects/{project_id}/collaborators
Path Parameters
Query Parameters
application/json
Add project collaborator
Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.
put
{protocol}://{hostname}/api/v3/projects/{project_id}/collaborators/{username}
Path Parameters
project_idintegerrequired
usernamestringrequired
Body
application/json
Body
application/json
permissionstring
The permission to grant the collaborator.
Allowed values:readwriteadmin
Default:write
Example:write
Response
Response
Response
put/projects/{project_id}/collaborators/{username}
Path Parameters
Body
{}