orgstringrequired
team_slugstringrequired
team_slug parameter
ownerstringrequired
repostringrequired
Remove a repository from a team
If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
delete
http://HOSTNAME/api/v3/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}
Path Parameters
Response
204
Response
204
Response
delete/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}
Path Parameters
204
List child teams
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.
get
http://HOSTNAME/api/v3/orgs/{org}/teams/{team_slug}/teams
Query Parameters
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
orgstringrequired
team_slugstringrequired
team_slug parameter
Response
200 application/json
Response
200 application/json
if child teams exist
Groups of organization members that gives permissions on specified repositories.
idintegerrequired
node_idstringrequired
namestringrequired
slugstringrequired
descriptionstring | nullrequired
privacystring
permissionstringrequired
permissionsobject
Show Child Parameters
urlstring(uri)required
html_urlstring(uri)required
Example:https://github.com/orgs/rails/teams/core
members_urlstringrequired
repositories_urlstring(uri)required
parentobject | nullrequired
Groups of organization members that gives permissions on specified repositories.
Show Child Parameters
get/orgs/{org}/teams/{team_slug}/teams
Path Parameters
Query Parameters
200 application/json
Get a team (Legacy)
DEPRECATEDDeprecation 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.
get
http://HOSTNAME/api/v3/teams/{team_id}
Path Parameters
team_idintegerrequired
Response
application/json
Response
application/json
Response
Full Team
Groups of organization members that gives permissions on specified repositories.
idintegerrequired
Unique identifier of the team
Example:42
node_idstringrequired
Example:MDQ6VGVhbTE=
urlstring(uri)required
URL for the team
Example:https://api.github.com/organizations/1/team/1
html_urlstring(uri)required
Example:https://github.com/orgs/rails/teams/core
namestringrequired
Name of the team
Example:Developers
slugstringrequired
Example:justice-league
descriptionstring | nullrequired
Example:A great team.
privacystring
The level of privacy this team should have
Allowed values:closedsecret
Example:closed
permissionstringrequired
Permission that the team will have for its repositories
Example:push
members_urlstringrequired
Example:https://api.github.com/organizations/1/team/1/members{/member}
repositories_urlstring(uri)required
Example:https://api.github.com/organizations/1/team/1/repos
parentobject | null
Groups of organization members that gives permissions on specified repositories.
Show Child Parameters
members_countintegerrequired
Example:3
repos_countintegerrequired
Example:10
created_atstring(date-time)required
Example:2017-07-14T16:53:42Z
updated_atstring(date-time)required
Example:2017-08-17T12:37:15Z
organizationobjectrequired
Organization Full
Show Child Parameters
ldap_dnstring
Distinguished Name (DN) that team maps to within LDAP environment
Example:uid=example,ou=users,dc=github,dc=com
get/teams/{team_id}
Path Parameters
application/json
Update a team (Legacy)
DEPRECATEDDeprecation 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.
patch
http://HOSTNAME/api/v3/teams/{team_id}
Path Parameters
team_idintegerrequired
Body
application/json
Body
application/json
namestringrequired
The name of the team.
descriptionstring
The description of the team.
privacystring
The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
For a non-nested team:
* secret - only visible to organization owners and members of this team.
* closed - visible to all members of this organization.
For a parent or child team:
* closed - visible to all members of this organization.
Allowed values:secretclosed
permissionstring
Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
* pull - team members can pull, but not push to or administer newly-added repositories.
* push - team members can pull and push, but not administer newly-added repositories.
* admin - team members can pull, push and administer newly-added repositories.
Allowed values:pullpushadmin
Default:pull
parent_team_idinteger | null
The ID of a team to set as the parent team.
Response
application/json
Response
application/json
Response
Full Team
Groups of organization members that gives permissions on specified repositories.
idintegerrequired
Unique identifier of the team
Example:42
node_idstringrequired
Example:MDQ6VGVhbTE=
urlstring(uri)required
URL for the team
Example:https://api.github.com/organizations/1/team/1
html_urlstring(uri)required
Example:https://github.com/orgs/rails/teams/core
namestringrequired
Name of the team
Example:Developers
slugstringrequired
Example:justice-league
descriptionstring | nullrequired
Example:A great team.
privacystring
The level of privacy this team should have
Allowed values:closedsecret
Example:closed
permissionstringrequired
Permission that the team will have for its repositories
Example:push
members_urlstringrequired
Example:https://api.github.com/organizations/1/team/1/members{/member}
repositories_urlstring(uri)required
Example:https://api.github.com/organizations/1/team/1/repos
parentobject | null
Groups of organization members that gives permissions on specified repositories.
Show Child Parameters
members_countintegerrequired
Example:3
repos_countintegerrequired
Example:10
created_atstring(date-time)required
Example:2017-07-14T16:53:42Z
updated_atstring(date-time)required
Example:2017-08-17T12:37:15Z
organizationobjectrequired
Organization Full
Show Child Parameters
ldap_dnstring
Distinguished Name (DN) that team maps to within LDAP environment
Example:uid=example,ou=users,dc=github,dc=com
patch/teams/{team_id}
Path Parameters
Body
{
"name": "new team name",
"description": "new team description",
"privacy": "closed"
}
application/json
Delete a team (Legacy)
DEPRECATEDDeprecation 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.
delete
http://HOSTNAME/api/v3/teams/{team_id}
Path Parameters
team_idintegerrequired
Response
Response
Response
delete/teams/{team_id}