How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Teams API

Interact with GitHub Teams.

GitHub Teams API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Team. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 83 operations across 42 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against 2 base URLs: {protocol}://{hostname}/api/v3, {protocol}://{hostname}.

83 operations 42 paths 28 schemas 18 DELETE37 GET8 PATCH11 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Teams API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 83

Across 42 paths, the API surfaces 83 operations — 18 DELETE, 37 GET, 8 PATCH, 11 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

Teams 83

Interact with GitHub Teams.

GET
/orgs/{org}/external-group/{group_id}
GitHub Get an External Group
teams/external-idp-group-info-for-org 2 params → 200
GET
/orgs/{org}/external-groups
GitHub List External Groups in an Organization
teams/list-external-idp-groups-for-org 4 params → 200
GET
/orgs/{org}/teams
GitHub List Teams
teams/list 3 params → 200403
POST
/orgs/{org}/teams
GitHub Create a Team
teams/create 1 param body → 201403422
GET
/orgs/{org}/teams/{team_slug}
GitHub Get a Team by Name
teams/get-by-name 2 params → 200404
PATCH
/orgs/{org}/teams/{team_slug}
GitHub Update a Team
teams/update-in-org 2 params body → 200201403404422
DELETE
/orgs/{org}/teams/{team_slug}
GitHub Delete a Team
teams/delete-in-org 2 params → 204
GET
/orgs/{org}/teams/{team_slug}/discussions
GitHub List Discussions
teams/list-discussions-in-org 6 params → 200
POST
/orgs/{org}/teams/{team_slug}/discussions
GitHub Create a Discussion
teams/create-discussion-in-org 2 params body → 201
GET
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}
GitHub Get a Discussion
teams/get-discussion-in-org 3 params → 200
PATCH
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}
GitHub Update a Discussion
teams/update-discussion-in-org 3 params body → 200
DELETE
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}
GitHub Delete a Discussion
teams/delete-discussion-in-org 3 params → 204
GET
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments
GitHub List Discussion Comments
teams/list-discussion-comments-in-org 6 params → 200
POST
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments
GitHub Create a Discussion Comment
teams/create-discussion-comment-in-org 3 params body → 201
GET
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}
GitHub Get a Discussion Comment
teams/get-discussion-comment-in-org 4 params → 200
PATCH
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}
GitHub Update a Discussion Comment
teams/update-discussion-comment-in-org 4 params body → 200
DELETE
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}
GitHub Delete a Discussion Comment
teams/delete-discussion-comment-in-org 4 params → 204
GET
/orgs/{org}/teams/{team_slug}/external-groups
GitHub List a Connection Between an External Group and a Team
teams/list-linked-external-idp-groups-to-team-for-org 2 params → 200
PATCH
/orgs/{org}/teams/{team_slug}/external-groups
GitHub Update the Connection Between an External Group and a Team
teams/link-external-idp-group-to-team-for-org 2 params body → 200
DELETE
/orgs/{org}/teams/{team_slug}/external-groups
GitHub Remove the Connection Between an External Group and a Team
teams/unlink-external-idp-group-from-team-for-org 2 params → 204
GET
/orgs/{org}/teams/{team_slug}/members
GitHub List Team Members
teams/list-members-in-org 5 params → 200
GET
/orgs/{org}/teams/{team_slug}/memberships/{username}
GitHub Get Team Membership for a User
teams/get-membership-for-user-in-org 3 params → 200404
PUT
/orgs/{org}/teams/{team_slug}/memberships/{username}
GitHub Add or Update Team Membership for a User
teams/add-or-update-membership-for-user-in-org 3 params body → 200403422
DELETE
/orgs/{org}/teams/{team_slug}/memberships/{username}
GitHub Remove Team Membership for a User
teams/remove-membership-for-user-in-org 3 params → 204403
GET
/orgs/{org}/teams/{team_slug}/projects
GitHub List Team Projects
teams/list-projects-in-org 4 params → 200
GET
/orgs/{org}/teams/{team_slug}/projects/{project_id}
GitHub Check Team Permissions for a Project
teams/check-permissions-for-project-in-org 3 params → 200404
PUT
/orgs/{org}/teams/{team_slug}/projects/{project_id}
GitHub Add or Update Team Project Permissions
teams/add-or-update-project-permissions-in-org 3 params body → 204403
DELETE
/orgs/{org}/teams/{team_slug}/projects/{project_id}
GitHub Remove a Project from a Team
teams/remove-project-in-org 3 params → 204
GET
/orgs/{org}/teams/{team_slug}/repos
GitHub List Team Repositories
teams/list-repos-in-org 4 params → 200
GET
/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}
GitHub Check Team Permissions for a Repository
teams/check-permissions-for-repo-in-org 4 params → 200204404
PUT
/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}
GitHub Add or Update Team Repository Permissions
teams/add-or-update-repo-permissions-in-org 4 params body → 204
DELETE
/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}
GitHub Remove a Repository from a Team
teams/remove-repo-in-org 4 params → 204
GET
/orgs/{org}/teams/{team_slug}/teams
GitHub List Child Teams
teams/list-child-in-org 4 params → 200
GET
/teams/{team_id}deprecated
GitHub Get a Team (Legacy)
teams/get-legacy 1 param → 200404
PATCH
/teams/{team_id}deprecated
GitHub Update a Team (Legacy)
teams/update-legacy 1 param body → 200201403404422
DELETE
/teams/{team_id}deprecated
GitHub Delete a Team (Legacy)
teams/delete-legacy 1 param → 204404422
GET
/teams/{team_id}/discussionsdeprecated
GitHub List Discussions (Legacy)
teams/list-discussions-legacy 4 params → 200
POST
/teams/{team_id}/discussionsdeprecated
GitHub Create a Discussion (Legacy)
teams/create-discussion-legacy 1 param body → 201
GET
/teams/{team_id}/discussions/{discussion_number}deprecated
GitHub Get a Discussion (Legacy)
teams/get-discussion-legacy 2 params → 200
PATCH
/teams/{team_id}/discussions/{discussion_number}deprecated
GitHub Update a Discussion (Legacy)
teams/update-discussion-legacy 2 params body → 200
DELETE
/teams/{team_id}/discussions/{discussion_number}deprecated
GitHub Delete a Discussion (Legacy)
teams/delete-discussion-legacy 2 params → 204
GET
/teams/{team_id}/discussions/{discussion_number}/commentsdeprecated
GitHub List Discussion Comments (Legacy)
teams/list-discussion-comments-legacy 5 params → 200
POST
/teams/{team_id}/discussions/{discussion_number}/commentsdeprecated
GitHub Create a Discussion Comment (Legacy)
teams/create-discussion-comment-legacy 2 params body → 201
GET
/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}deprecated
GitHub Get a Discussion Comment (Legacy)
teams/get-discussion-comment-legacy 3 params → 200
PATCH
/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}deprecated
GitHub Update a Discussion Comment (Legacy)
teams/update-discussion-comment-legacy 3 params body → 200
DELETE
/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}deprecated
GitHub Delete a Discussion Comment (Legacy)
teams/delete-discussion-comment-legacy 3 params → 204
GET
/teams/{team_id}/membersdeprecated
GitHub List Team Members (Legacy)
teams/list-members-legacy 4 params → 200404
GET
/teams/{team_id}/members/{username}deprecated
GitHub Get Team Member (Legacy)
teams/get-member-legacy 2 params → 204404
PUT
/teams/{team_id}/members/{username}deprecated
GitHub Add Team Member (Legacy)
teams/add-member-legacy 2 params → 204403404422
DELETE
/teams/{team_id}/members/{username}deprecated
GitHub Remove Team Member (Legacy)
teams/remove-member-legacy 2 params → 204404
GET
/teams/{team_id}/memberships/{username}deprecated
GitHub Get Team Membership for a User (Legacy)
teams/get-membership-for-user-legacy 2 params → 200404
PUT
/teams/{team_id}/memberships/{username}deprecated
GitHub Add or Update Team Membership for a User (Legacy)
teams/add-or-update-membership-for-user-legacy 2 params body → 200403404422
DELETE
/teams/{team_id}/memberships/{username}deprecated
GitHub Remove Team Membership for a User (Legacy)
teams/remove-membership-for-user-legacy 2 params → 204403
GET
/teams/{team_id}/projectsdeprecated
GitHub List Team Projects (Legacy)
teams/list-projects-legacy 3 params → 200404
GET
/teams/{team_id}/projects/{project_id}deprecated
GitHub Check Team Permissions for a Project (Legacy)
teams/check-permissions-for-project-legacy 2 params → 200404
PUT
/teams/{team_id}/projects/{project_id}deprecated
GitHub Add or Update Team Project Permissions (Legacy)
teams/add-or-update-project-permissions-legacy 2 params body → 204403404422
DELETE
/teams/{team_id}/projects/{project_id}deprecated
GitHub Remove a Project from a Team (Legacy)
teams/remove-project-legacy 2 params → 204404422
GET
/teams/{team_id}/reposdeprecated
GitHub List Team Repositories (Legacy)
teams/list-repos-legacy 3 params → 200404
GET
/teams/{team_id}/repos/{owner}/{repo}deprecated
GitHub Check Team Permissions for a Repository (Legacy)
teams/check-permissions-for-repo-legacy 3 params → 200204404
PUT
/teams/{team_id}/repos/{owner}/{repo}deprecated
GitHub Add or Update Team Repository Permissions (Legacy)
teams/add-or-update-repo-permissions-legacy 3 params body → 204403422
DELETE
/teams/{team_id}/repos/{owner}/{repo}deprecated
GitHub Remove a Repository from a Team (Legacy)
teams/remove-repo-legacy 3 params → 204
GET
/teams/{team_id}/teamsdeprecated
GitHub List Child Teams (Legacy)
teams/list-child-legacy 3 params → 200403404422
GET
/user/teams
GitHub List Teams for the Authenticated User
teams/list-for-authenticated-user 2 params → 200304403404
GET
/orgs/{org}/security-managers
GitHub List Security Manager Teams
listSecurityManagerTeams 1 param → 200
PUT
/orgs/{org}/security-managers/teams/{team_slug}
GitHub Add Security Manager Team
addSecurityManagerTeam 2 params → 204409
DELETE
/orgs/{org}/security-managers/teams/{team_slug}
GitHub Remove Security Manager Team
removeSecurityManagerTeam 2 params → 204
GET
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions
GitHub List Reactions for Team Discussion Comment
listReactionsForTeamDiscussionComment 7 params → 200
POST
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions
GitHub Create Reaction for Team Discussion Comment
createReactionForTeamDiscussionComment 4 params body → 200201
DELETE
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}
GitHub Delete Team Discussion Comment Reaction
deleteTeamDiscussionCommentReaction 5 params → 204
GET
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions
GitHub List Reactions for Team Discussion
listReactionsForTeamDiscussion 6 params → 200
POST
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions
GitHub Create Reaction for Team Discussion
createReactionForTeamDiscussion 3 params body → 200201
DELETE
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}
GitHub Delete Team Discussion Reaction
deleteTeamDiscussionReaction 4 params → 204
GET
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
GitHub Get Teams with Access to the Protected Branch
getTeamsWithAccessToTheProtectedBranch 6 params → 200404
POST
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
GitHub Add Team Access Restrictions
addTeamAccessRestrictions 6 params body → 200422
PUT
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
GitHub Set Team Access Restrictions
setTeamAccessRestrictions 6 params body → 200422
DELETE
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
GitHub Remove Team Access Restrictions
removeTeamAccessRestrictions 6 params body → 200422
GET
/repos/{owner}/{repo}/teams
GitHub List Repository Teams
listRepositoryTeams 7 params → 200404
PATCH
/admin/ldap/teams/{team_id}/mapping
GitHub Update Ldap Mapping for Team
updateLdapMappingForTeam 1 param body → 200
POST
/admin/ldap/teams/{team_id}/sync
GitHub Sync Ldap Mapping for Team
syncLdapMappingForTeam 1 param → 201
GET
/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactionsdeprecated
GitHub List Reactions for Team Discussion Comment (legacy)
listReactionsForTeamDiscussionCommentLegacy 6 params → 200
POST
/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactionsdeprecated
GitHub Create Reaction for Team Discussion Comment (legacy)
createReactionForTeamDiscussionCommentLegacy 3 params body → 201
GET
/teams/{team_id}/discussions/{discussion_number}/reactionsdeprecated
GitHub List Reactions for Team Discussion (legacy)
listReactionsForTeamDiscussionLegacy 5 params → 200
POST
/teams/{team_id}/discussions/{discussion_number}/reactionsdeprecated
GitHub Create Reaction for Team Discussion (legacy)
createReactionForTeamDiscussionLegacy 2 params body → 201

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are team-repository (89 properties), minimal-repository (87 properties), team-organization (48 properties), simple-user (21 properties). Each schema is shown below with its type and property counts.

team-organization
object
Team Organization
48 properties 23 required
code-of-conduct
object
Code Of Conduct
5 properties 4 required
minimal-repository
object
Minimal Repository
87 properties 46 required
team-full
object
Groups of organization members that gives permissions on specified repositories.
18 properties 15 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
security-and-analysis
objectnull
3 properties
simple-user
object
A GitHub user.
21 properties 18 required
validation-error
object
Validation Error
3 properties 2 required
basic-error
object
Basic Error
4 properties
external-group
object
Information about an external group's usage and its members
5 properties 4 required
team-discussion
object
A team discussion is a persistent record of a free-form conversation within a team.
18 properties 17 required
external-groups
object
A list of external groups available to be connected to a team
1 property
team-membership
object
Team Membership
3 properties 3 required
team-repository
object
A team's access to a repository.
89 properties 73 required
reaction-rollup
object
10 properties 10 required
nullable-team-simple
objectnull
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
team-project
object
A team's access to a project.
16 properties 14 required
team-discussion-comment
object
A reply to a discussion within a team.
13 properties 12 required
nullable-simple-user
objectnull
A GitHub user.
21 properties 18 required
nullable-license-simple
objectnull
License Simple
6 properties 5 required
team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
reaction
object
Reactions to conversations provide a way to help people express their feelings more simply and effectively.
5 properties 5 required
validation-error_2
object
Validation Error
3 properties 2 required
team_2
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
nullable-team-simple_2
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
team_3
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
nullable-team-simple_3
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
ldap-mapping-team
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-teams-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Teams API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.