Sign in

v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2024-01-0382859610.0 MB
teams

Check team permissions for a repository

Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.

If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.

If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

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

Path parameters

orgstring required

The organization name. The name is not case sensitive.

team_slugstring required

The slug of the team name.

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

Response

Alternative response with repository permissions

idinteger required

Unique identifier of the repository

node_idstring required
namestring required

The name of the repository.

full_namestring required
forksinteger required
role_namestring
privateboolean required

Whether the repository is private or public.

html_urlstring uri required
descriptionstring nullable required
forkboolean required
urlstring uri required
archive_urlstring required
assignees_urlstring required
blobs_urlstring required
branches_urlstring required
collaborators_urlstring required
comments_urlstring required
commits_urlstring required
compare_urlstring required
contents_urlstring required
contributors_urlstring uri required
deployments_urlstring uri required
downloads_urlstring uri required
events_urlstring uri required
forks_urlstring uri required
git_commits_urlstring required
git_refs_urlstring required
git_tags_urlstring required
git_urlstring required
issue_comment_urlstring required
issue_events_urlstring required
issues_urlstring required
keys_urlstring required
labels_urlstring required
languages_urlstring uri required
merges_urlstring uri required
milestones_urlstring required
notifications_urlstring required
pulls_urlstring required
releases_urlstring required
ssh_urlstring required
stargazers_urlstring uri required
statuses_urlstring required
subscribers_urlstring uri required
subscription_urlstring uri required
tags_urlstring uri required
teams_urlstring uri required
trees_urlstring required
clone_urlstring required
mirror_urlstring uri nullable required
hooks_urlstring uri required
svn_urlstring uri required
homepagestring uri nullable required
languagestring nullable required
forks_countinteger required
stargazers_countinteger required
watchers_countinteger required
sizeinteger required
default_branchstring required

The default branch of the repository.

open_issues_countinteger required
is_templateboolean

Whether this repository acts as a template that can be used to generate new repositories.

topicsstring[]
has_issuesboolean required

Whether issues are enabled.

has_projectsboolean required

Whether projects are enabled.

has_wikiboolean required

Whether the wiki is enabled.

has_pagesboolean required
has_downloadsboolean required

Whether downloads are enabled.

archivedboolean required

Whether the repository is archived.

disabledboolean required

Returns whether or not this repository disabled.

visibilitystring

The repository visibility: public, private, or internal.

pushed_atstring date-time nullable required
created_atstring date-time nullable required
updated_atstring date-time nullable required
allow_rebase_mergeboolean

Whether to allow rebase merges for pull requests.

temp_clone_tokenstring
allow_squash_mergeboolean

Whether to allow squash merges for pull requests.

allow_auto_mergeboolean

Whether to allow Auto-merge to be used on pull requests.

delete_branch_on_mergeboolean

Whether to delete head branches when pull requests are merged

allow_merge_commitboolean

Whether to allow merge commits for pull requests.

allow_forkingboolean

Whether to allow forking this repo

web_commit_signoff_requiredboolean

Whether to require contributors to sign off on web-based commits

subscribers_countinteger
network_countinteger
open_issuesinteger required
watchersinteger required
master_branchstring

Example response

{
  "id": 42,
  "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
  "name": "Team Environment",
  "full_name": "octocat/Hello-World",
  "license": {
    "key": "mit",
    "name": "MIT License",
    "url": "https://api.github.com/licenses/mit",
    "spdx_id": "MIT",
    "node_id": "MDc6TGljZW5zZW1pdA=="
  },
  "role_name": "admin",
  "owner": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "starred_at": "\"2020-07-09T00:17:55Z\""
  },
  "html_url": "https://github.com/octocat/Hello-World",
  "description": "This your first repo!",
  "url": "https://api.github.com/repos/octocat/Hello-World",
  "archive_url": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
  "assignees_url": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}",
  "blobs_url": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
  "branches_url": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}",
  "collaborators_url": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
  "comments_url": "http://api.github.com/repos/octocat/Hello-World/comments{/number}",
  "commits_url": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}",
  "compare_url": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
  "contents_url": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}",
  "contributors_url": "http://api.github.com/repos/octocat/Hello-World/contributors",
  "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments",
  "downloads_url": "http://api.github.com/repos/octocat/Hello-World/downloads",
  "events_url": "http://api.github.com/repos/octocat/Hello-World/events",
  "forks_url": "http://api.github.com/repos/octocat/Hello-World/forks",
  "git_commits_url": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
  "git_refs_url": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
  "git_tags_url": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
  "git_url": "git:github.com/octocat/Hello-World.git",
  "issue_comment_url": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
  "issue_events_url": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
  "issues_url": "http://api.github.com/repos/octocat/Hello-World/issues{/number}",
  "keys_url": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
  "labels_url": "http://api.github.com/repos/octocat/Hello-World/labels{/name}",
  "languages_url": "http://api.github.com/repos/octocat/Hello-World/languages",
  "merges_url": "http://api.github.com/repos/octocat/Hello-World/merges",
  "milestones_url": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}",
  "notifications_url": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
  "pulls_url": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}",
  "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}",
  "ssh_url": "git@github.com:octocat/Hello-World.git",
  "stargazers_url": "http://api.github.com/repos/octocat/Hello-World/stargazers",
  "statuses_url": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
  "subscribers_url": "http://api.github.com/repos/octocat/Hello-World/subscribers",
  "subscription_url": "http://api.github.com/repos/octocat/Hello-World/subscription",
  "tags_url": "http://api.github.com/repos/octocat/Hello-World/tags",
  "teams_url": "http://api.github.com/repos/octocat/Hello-World/teams",
  "trees_url": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
  "clone_url": "https://github.com/octocat/Hello-World.git",
  "mirror_url": "git:git.example.com/octocat/Hello-World",
  "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
  "svn_url": "https://svn.github.com/octocat/Hello-World",
  "homepage": "https://github.com",
  "forks_count": 9,
  "stargazers_count": 80,
  "watchers_count": 80,
  "size": 108,
  "default_branch": "master",
  "is_template": true,
  "has_issues": true,
  "has_projects": true,
  "has_wiki": true,
  "has_downloads": true,
  "pushed_at": "2011-01-26T19:06:43Z",
  "created_at": "2011-01-26T19:01:12Z",
  "updated_at": "2011-01-26T19:14:43Z",
  "allow_rebase_merge": true,
  "allow_squash_merge": true,
  "allow_merge_commit": true
}