per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
List teams
Lists all teams in an organization that are visible to the authenticated user.
get
{protocol}://{hostname}/api/v3/orgs/{org}/teams
Query Parameters
Path Parameters
orgstringrequired
Response
application/json
Response
application/json
Response
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
Path Parameters
Query Parameters
application/json
Create a team
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”.
post
{protocol}://{hostname}/api/v3/orgs/{org}/teams
Path Parameters
orgstringrequired
Body
application/json
Body
application/json
namestringrequired
The name of the team.
descriptionstring
The description of the team.
maintainersarray[string]
List GitHub IDs for organization members who will become team maintainers.
repo_namesarray[string]
The full name (e.g., “organization-name/repository-name”) of repositories to add the team to.
privacystring
The level of privacy this team should have. 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.
Default: secret
For a parent or child team:
* closed - visible to all members of this organization.
Default for child team: closed
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.
Allowed values:pullpush
Default:pull
parent_team_idinteger
The ID of a team to set as the parent team.
ldap_dnstring
The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the “Update LDAP mapping for a team” endpoint to change the LDAP DN. For more information, see “Using LDAP.”
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
post/orgs/{org}/teams
Path Parameters
Body
{
"name": "Justice League",
"description": "A great team",
"permission": "push",
"privacy": "closed"
}
application/json
Get a team by name
Gets a team using the team’s slug. GitHub Enterprise Server generates the slug from the team name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
get
{protocol}://{hostname}/api/v3/orgs/{org}/teams/{team_slug}
Path Parameters
orgstringrequired
team_slugstringrequired
team_slug parameter
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/orgs/{org}/teams/{team_slug}
Path Parameters
application/json
Update a team
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}.
patch
{protocol}://{hostname}/api/v3/orgs/{org}/teams/{team_slug}
Path Parameters
orgstringrequired
team_slugstringrequired
team_slug parameter
Body
application/json
Body
application/json
namestring
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. When a team is nested, the privacy for parent teams cannot be secret. 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
201 application/json
Response
201 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/orgs/{org}/teams/{team_slug}
Path Parameters
Body
{
"name": "new team name",
"description": "new team description",
"privacy": "closed"
}
201 application/json
Delete a team
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
{protocol}://{hostname}/api/v3/orgs/{org}/teams/{team_slug}
Path Parameters
orgstringrequired
team_slugstringrequired
team_slug parameter
Response
204
Response
204
Response
delete/orgs/{org}/teams/{team_slug}
Path Parameters
204