team_idintegerrequired
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
{protocol}://{hostname}/api/v3/teams/{team_id}
Path Parameters
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
{protocol}://{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
{protocol}://{hostname}/api/v3/teams/{team_id}
Path Parameters
team_idintegerrequired
Response
Response
Response
delete/teams/{team_id}
Path Parameters
List discussions (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 List discussions endpoint.
List all discussions on a team’s page. OAuth access tokens require the read:discussion scope.
get
{protocol}://{hostname}/api/v3/teams/{team_id}/discussions
Query Parameters
directionstring
One of asc (ascending) or desc (descending).
Allowed values:ascdesc
Default:desc
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
team_idintegerrequired
Response
200 application/json
Response
200 application/json
Response
A team discussion is a persistent record of a free-form conversation within a team.
authorobject | nullrequired
Simple User
Show Child Parameters
bodystringrequired
The main text of the discussion.
Example:Please suggest improvements to our workflow in comments.
body_htmlstringrequired
Example:<p>Hi! This is an area for us to collaborate as a team</p>
body_versionstringrequired
The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
Example:0307116bbf7ced493b8d8a346c650b71
comments_countintegerrequired
Example:0
comments_urlstring(uri)required
Example:https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_atstring(date-time)required
Example:2018-01-25T18:56:31Z
last_edited_atstring | null(date-time)required
html_urlstring(uri)required
Example:https://github.com/orgs/github/teams/justice-league/discussions/1
node_idstringrequired
Example:MDE0OlRlYW1EaXNjdXNzaW9uMQ==
numberintegerrequired
The unique sequence number of a team discussion.
Example:42
pinnedbooleanrequired
Whether or not this discussion should be pinned for easy retrieval.
Example:true
privatebooleanrequired
Whether or not this discussion should be restricted to team members and organization administrators.
Example:true
team_urlstring(uri)required
Example:https://api.github.com/organizations/1/team/2343027
titlestringrequired
The title of the discussion.
Example:How can we improve our workflow?
updated_atstring(date-time)required
Example:2018-01-25T18:56:31Z
urlstring(uri)required
Example:https://api.github.com/organizations/1/team/2343027/discussions/1
reactionsobject
Show Child Parameters
get/teams/{team_id}/discussions
Path Parameters
Query Parameters
200 application/json
Create a discussion (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 Create a discussion endpoint.
Creates a new discussion post on a team’s page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.
post
{protocol}://{hostname}/api/v3/teams/{team_id}/discussions
Path Parameters
team_idintegerrequired
Body
application/json
Body
application/json
titlestringrequired
The discussion post’s title.
bodystringrequired
The discussion post’s body text.
privateboolean
Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.
Default:false
Response
201 application/json
Response
201 application/json
Response
Team Discussion
A team discussion is a persistent record of a free-form conversation within a team.
authorobject | nullrequired
Simple User
Show Child Parameters
bodystringrequired
The main text of the discussion.
Example:Please suggest improvements to our workflow in comments.
body_htmlstringrequired
Example:<p>Hi! This is an area for us to collaborate as a team</p>
body_versionstringrequired
The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
Example:0307116bbf7ced493b8d8a346c650b71
comments_countintegerrequired
Example:0
comments_urlstring(uri)required
Example:https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_atstring(date-time)required
Example:2018-01-25T18:56:31Z
last_edited_atstring | null(date-time)required
html_urlstring(uri)required
Example:https://github.com/orgs/github/teams/justice-league/discussions/1
node_idstringrequired
Example:MDE0OlRlYW1EaXNjdXNzaW9uMQ==
numberintegerrequired
The unique sequence number of a team discussion.
Example:42
pinnedbooleanrequired
Whether or not this discussion should be pinned for easy retrieval.
Example:true
privatebooleanrequired
Whether or not this discussion should be restricted to team members and organization administrators.
Example:true
team_urlstring(uri)required
Example:https://api.github.com/organizations/1/team/2343027
titlestringrequired
The title of the discussion.
Example:How can we improve our workflow?
updated_atstring(date-time)required
Example:2018-01-25T18:56:31Z
urlstring(uri)required
Example:https://api.github.com/organizations/1/team/2343027/discussions/1
reactionsobject
Show Child Parameters
post/teams/{team_id}/discussions
Path Parameters
Body
{
"title": "Our first team post",
"body": "Hi! This is an area for us to collaborate as a team."
}
201 application/json