Skip to main content

projects

Overview

Nameprojects
TypeResource
Idgithub.teams.projects

Fields

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

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.
list_projects_legacySELECTteam_idDeprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.

Lists the organization projects for a team.
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}.
remove_project_legacyEXECproject_id, team_idDeprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.

Removes 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. Note: This endpoint removes the project from the team, but does not delete it.