Skip to main content

projects

Overview

Nameprojects
TypeResource
Idgithub.teams.projects

Fields

NameDatatypeDescription
idinteger
namestring
urlstring
columns_urlstring
html_urlstring
node_idstring
privatebooleanWhether the project is private or not. Only present when owner is an organization.
numberinteger
bodystring
owner_urlstring
creatorobjectSimple User
organization_permissionstringThe organization permission for this project. Only present when owner is an organization.
updated_atstring
created_atstring
permissionsobject
statestring

Methods

NameAccessible byRequired ParamsDescription
list_projects_in_orgSELECTorg, team_slugLists the organization projects for a team.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.
add_or_update_project_permissions_in_orgINSERTorg, project_id, team_slugAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
remove_project_in_orgDELETEorg, project_id, team_slugRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}.
check_permissions_for_project_in_orgEXECorg, project_id, team_slugChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.