APIs.io Engineering Platform Teams API

Interact with GitHub Teams.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 63 operations across 30 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

63 operations 30 paths 20 schemas 14 DELETE30 GET7 PATCH5 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Teams API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

hmac — Amazon Signature authorization v4

Paths & Operations 63

Across 30 paths, the API surfaces 63 operations — 14 DELETE, 30 GET, 7 PATCH, 5 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Teams 63

Interact with GitHub Teams.

GET

/orgs/{org}/external-group/{group_id}

APIs.io Engineering Platform Get an external group

teams/external-idp-group-info-for-org 2 params → 200

GET

/orgs/{org}/external-groups

APIs.io Engineering Platform List external groups in an organization

teams/list-external-idp-groups-for-org 4 params → 200

GET

/orgs/{org}/teams

APIs.io Engineering Platform List teams

teams/list 3 params → 200403

POST

/orgs/{org}/teams

APIs.io Engineering Platform Create a team

teams/create 1 param body → 201422403

GET

/orgs/{org}/teams/{team_slug}

APIs.io Engineering Platform Get a team by name

teams/get-by-name 2 params → 200404

PATCH

/orgs/{org}/teams/{team_slug}

APIs.io Engineering Platform Update a team

teams/update-in-org 2 params body → 200201404422403

DELETE

/orgs/{org}/teams/{team_slug}

APIs.io Engineering Platform Delete a team

teams/delete-in-org 2 params → 204

GET

/orgs/{org}/teams/{team_slug}/discussions

APIs.io Engineering Platform List discussions

teams/list-discussions-in-org 6 params → 200

POST

/orgs/{org}/teams/{team_slug}/discussions

APIs.io Engineering Platform Create a discussion

teams/create-discussion-in-org 2 params body → 201

GET

/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}

APIs.io Engineering Platform Get a discussion

teams/get-discussion-in-org 3 params → 200

PATCH

/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}

APIs.io Engineering Platform Update a discussion

teams/update-discussion-in-org 3 params body → 200

DELETE

/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}

APIs.io Engineering Platform Delete a discussion

teams/delete-discussion-in-org 3 params → 204

GET

/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments

APIs.io Engineering Platform List discussion comments

teams/list-discussion-comments-in-org 6 params → 200

POST

/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform Delete a discussion comment

teams/delete-discussion-comment-in-org 4 params → 204

GET

/orgs/{org}/teams/{team_slug}/external-groups

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform List team members

teams/list-members-in-org 5 params → 200

GET

/orgs/{org}/teams/{team_slug}/memberships/{username}

APIs.io Engineering Platform Get team membership for a user

teams/get-membership-for-user-in-org 3 params → 200404

PUT

/orgs/{org}/teams/{team_slug}/memberships/{username}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform Remove team membership for a user

teams/remove-membership-for-user-in-org 3 params → 204403

GET

/orgs/{org}/teams/{team_slug}/projects

APIs.io Engineering Platform List team projects

teams/list-projects-in-org 4 params → 200

GET

/orgs/{org}/teams/{team_slug}/projects/{project_id}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform Remove a project from a team

teams/remove-project-in-org 3 params → 204

GET

/orgs/{org}/teams/{team_slug}/repos

APIs.io Engineering Platform List team repositories

teams/list-repos-in-org 4 params → 200

GET

/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform Remove a repository from a team

teams/remove-repo-in-org 4 params → 204

GET

/orgs/{org}/teams/{team_slug}/teams

APIs.io Engineering Platform List child teams

teams/list-child-in-org 4 params → 200

GET

/teams/{team_id}deprecated

APIs.io Engineering Platform Get a team (Legacy)

teams/get-legacy 1 param → 200404

PATCH

/teams/{team_id}deprecated

APIs.io Engineering Platform Update a team (Legacy)

teams/update-legacy 1 param body → 200201404422403

DELETE

/teams/{team_id}deprecated

APIs.io Engineering Platform Delete a team (Legacy)

teams/delete-legacy 1 param → 204404422

GET

/teams/{team_id}/discussionsdeprecated

APIs.io Engineering Platform List discussions (Legacy)

teams/list-discussions-legacy 4 params → 200

POST

/teams/{team_id}/discussionsdeprecated

APIs.io Engineering Platform Create a discussion (Legacy)

teams/create-discussion-legacy 1 param body → 201

GET

/teams/{team_id}/discussions/{discussion_number}deprecated

APIs.io Engineering Platform Get a discussion (Legacy)

teams/get-discussion-legacy 2 params → 200

PATCH

/teams/{team_id}/discussions/{discussion_number}deprecated

APIs.io Engineering Platform Update a discussion (Legacy)

teams/update-discussion-legacy 2 params body → 200

DELETE

/teams/{team_id}/discussions/{discussion_number}deprecated

APIs.io Engineering Platform Delete a discussion (Legacy)

teams/delete-discussion-legacy 2 params → 204

GET

/teams/{team_id}/discussions/{discussion_number}/commentsdeprecated

APIs.io Engineering Platform List discussion comments (Legacy)

teams/list-discussion-comments-legacy 5 params → 200

POST

/teams/{team_id}/discussions/{discussion_number}/commentsdeprecated

APIs.io Engineering Platform 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

APIs.io Engineering Platform Get a discussion comment (Legacy)

teams/get-discussion-comment-legacy 3 params → 200

PATCH

/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}deprecated

APIs.io Engineering Platform 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

APIs.io Engineering Platform Delete a discussion comment (Legacy)

teams/delete-discussion-comment-legacy 3 params → 204

GET

/teams/{team_id}/membersdeprecated

APIs.io Engineering Platform List team members (Legacy)

teams/list-members-legacy 4 params → 200404

GET

/teams/{team_id}/members/{username}deprecated

APIs.io Engineering Platform Get team member (Legacy)

teams/get-member-legacy 2 params → 204404

PUT

/teams/{team_id}/members/{username}deprecated

APIs.io Engineering Platform Add team member (Legacy)

teams/add-member-legacy 2 params → 204404422403

DELETE

/teams/{team_id}/members/{username}deprecated

APIs.io Engineering Platform Remove team member (Legacy)

teams/remove-member-legacy 2 params → 204404

GET

/teams/{team_id}/memberships/{username}deprecated

APIs.io Engineering Platform Get team membership for a user (Legacy)

teams/get-membership-for-user-legacy 2 params → 200404

PUT

/teams/{team_id}/memberships/{username}deprecated

APIs.io Engineering Platform Add or update team membership for a user (Legacy)

teams/add-or-update-membership-for-user-legacy 2 params body → 200403422404

DELETE

/teams/{team_id}/memberships/{username}deprecated

APIs.io Engineering Platform Remove team membership for a user (Legacy)

teams/remove-membership-for-user-legacy 2 params → 204403

GET

/teams/{team_id}/projectsdeprecated

APIs.io Engineering Platform List team projects (Legacy)

teams/list-projects-legacy 3 params → 200404

GET

/teams/{team_id}/projects/{project_id}deprecated

APIs.io Engineering Platform Check team permissions for a project (Legacy)

teams/check-permissions-for-project-legacy 2 params → 200404

PUT

/teams/{team_id}/projects/{project_id}deprecated

APIs.io Engineering Platform 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

APIs.io Engineering Platform Remove a project from a team (Legacy)

teams/remove-project-legacy 2 params → 204404422

GET

/teams/{team_id}/reposdeprecated

APIs.io Engineering Platform List team repositories (Legacy)

teams/list-repos-legacy 3 params → 200404

GET

/teams/{team_id}/repos/{owner}/{repo}deprecated

APIs.io Engineering Platform Check team permissions for a repository (Legacy)

teams/check-permissions-for-repo-legacy 3 params → 200204404

PUT

/teams/{team_id}/repos/{owner}/{repo}deprecated

APIs.io Engineering Platform 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

APIs.io Engineering Platform Remove a repository from a team (Legacy)

teams/remove-repo-legacy 3 params → 204

GET

/teams/{team_id}/teamsdeprecated

APIs.io Engineering Platform List child teams (Legacy)

teams/list-child-legacy 3 params → 200404403422

GET

/user/teams

APIs.io Engineering Platform List teams for the authenticated user

teams/list-for-authenticated-user 2 params → 200304404403

Schemas 20

The contract defines 20 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.

nullable-simple-user

object

A GitHub user.

21 properties 18 required

team-discussion-comment

object

A reply to a discussion within a team.

13 properties 12 required

code-of-conduct

object

Code Of Conduct

5 properties 4 required

external-group

object

Information about an external group's usage and its members

5 properties 4 required

external-groups

object

A list of external groups available to be connected to a team

1 property

basic-error

object

Basic Error

4 properties

reaction-rollup

object

10 properties 10 required

validation-error

object

Validation Error

3 properties 2 required

team

object

Groups of organization members that gives permissions on specified repositories.

13 properties 11 required

team-discussion

object

A team discussion is a persistent record of a free-form conversation within a team.

18 properties 17 required

team-organization

object

Team Organization

48 properties 23 required

team-membership

object

Team Membership

3 properties 3 required

team-project

object

A team's access to a project.

16 properties 14 required

simple-user

object

A GitHub user.

21 properties 18 required

team-full

object

Groups of organization members that gives permissions on specified repositories.

18 properties 15 required

minimal-repository

object

Minimal Repository

87 properties 46 required

nullable-team-simple

object

Groups of organization members that gives permissions on specified repositories.

12 properties 10 required

nullable-license-simple

object

License Simple

6 properties 5 required

security-and-analysis

object

3 properties

team-repository

object

A team's access to a repository.

89 properties 73 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Teams

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Teams API

Metadata

Authentication & Security 1

Paths & Operations 63

Schemas 20

Specification

Source

API Details

Provider

Explore more