teams

Overview

Name	teams
Type	Resource
Id	github.teams.teams

Fields

Name	Datatype	Description
id	integer
name	string
description	string
repositories_url	string
permissions	object
html_url	string
privacy	string
notification_setting	string
permission	string
node_id	string
members_url	string
slug	string
parent	object	Groups of organization members that gives permissions on specified repositories.
url	string

Methods

Name	Accessible by	Required Params	Description
list	SELECT	org	Lists all teams in an organization that are visible to the authenticated user.
list_child_in_org	SELECT	org, team_slug	Lists the child teams of the team specified by {team_slug}. Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
list_child_legacy	SELECT	team_id	Deprecation 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 child teams endpoint.
create	INSERT	org, data__name	To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "Setting team creation permissions." When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see "About teams".
delete_in_org	DELETE	org, team_slug	To delete a team, the authenticated user must be an organization owner or team maintainer. If you are an organization owner, deleting a parent team will delete all of its child teams as well. Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
delete_legacy	EXEC	team_id	Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint. To delete a team, the authenticated user must be an organization owner or team maintainer. If you are an organization owner, deleting a parent team will delete all of its child teams as well.
get_legacy	EXEC	team_id	Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
update_in_org	EXEC	org, team_slug	To edit a team, the authenticated user must either be an organization owner or a team maintainer. Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
update_legacy	EXEC	team_id, data__name	Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint. To edit a team, the authenticated user must either be an organization owner or a team maintainer. Note: With nested teams, the privacy for parent teams cannot be secret.