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

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}.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 parameters

orgstringrequired

The organization name. The name is not case sensitive.

team_slugstringrequired

The slug of the team name.

ownerstringrequired

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

repostringrequired

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

3 status codes

200Alternative response with repository permissions

idintegerrequired

Unique identifier of the repository

node_idstringrequired

namestringrequired

The name of the repository.

full_namestringrequired

licenseobjectrequired

License Simple

forksintegerrequired

permissionsobjectoptional

role_namestringoptional

ownerobjectrequired

A GitHub user.

privatebooleanrequired

Whether the repository is private or public.

Default:false

html_urlstringrequired

descriptionstringrequired

forkbooleanrequired

urlstringrequired

archive_urlstringrequired

assignees_urlstringrequired

blobs_urlstringrequired

branches_urlstringrequired

collaborators_urlstringrequired

comments_urlstringrequired

commits_urlstringrequired

compare_urlstringrequired

contents_urlstringrequired

contributors_urlstringrequired

deployments_urlstringrequired

downloads_urlstringrequired

events_urlstringrequired

forks_urlstringrequired

git_commits_urlstringrequired

git_refs_urlstringrequired

git_tags_urlstringrequired

git_urlstringrequired

issue_comment_urlstringrequired

issue_events_urlstringrequired

issues_urlstringrequired

keys_urlstringrequired

labels_urlstringrequired

languages_urlstringrequired

merges_urlstringrequired

milestones_urlstringrequired

notifications_urlstringrequired

pulls_urlstringrequired

releases_urlstringrequired

ssh_urlstringrequired

stargazers_urlstringrequired

statuses_urlstringrequired

subscribers_urlstringrequired

subscription_urlstringrequired

tags_urlstringrequired

teams_urlstringrequired

trees_urlstringrequired

clone_urlstringrequired

mirror_urlstringrequired

hooks_urlstringrequired

svn_urlstringrequired

homepagestringrequired

languagestringrequired

forks_countintegerrequired

stargazers_countintegerrequired

watchers_countintegerrequired

sizeintegerrequired

default_branchstringrequired

The default branch of the repository.

open_issues_countintegerrequired

is_templatebooleanoptional

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

Default:false

topicsarray<string>optional

has_issuesbooleanrequired

Whether issues are enabled.

Default:true

has_projectsbooleanrequired

Whether projects are enabled.

Default:true

has_wikibooleanrequired

Whether the wiki is enabled.

Default:true

has_pagesbooleanrequired

has_downloadsbooleanrequired

Whether downloads are enabled.

Default:true

archivedbooleanrequired

Whether the repository is archived.

Default:false

disabledbooleanrequired

Returns whether or not this repository disabled.

visibilitystringoptional

The repository visibility: public, private, or internal.

Default:public

pushed_atstringrequired

created_atstringrequired

updated_atstringrequired

allow_rebase_mergebooleanoptional

Whether to allow rebase merges for pull requests.

Default:true

temp_clone_tokenstringoptional

allow_squash_mergebooleanoptional

Whether to allow squash merges for pull requests.

Default:true

allow_auto_mergebooleanoptional

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

Default:false

delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

Default:false

allow_merge_commitbooleanoptional

Whether to allow merge commits for pull requests.

Default:true

allow_forkingbooleanoptional

Whether to allow forking this repo

Default:false

web_commit_signoff_requiredbooleanoptional

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

Default:false

subscribers_countintegeroptional

network_countintegeroptional

open_issuesintegerrequired

watchersintegerrequired

master_branchstringoptional

204Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header.

404Not Found if team does not have permission for the repository

Error handling

A 404 is returned: Not Found if team does not have permission for the repository.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.repos.get({
  org: "acme-inc",
  teamSlug: "my-resource",
  owner: "octocat",
  repo: "hello-world",
});

{
  "id": 1296269,
  "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
  "name": "Hello-World",
  "full_name": "octocat/Hello-World",
  "owner": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "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",
    "site_admin": false
  },
  "private": false,
  "html_url": "https://github.com/octocat/Hello-World",
  "description": "This your first repo!",
  "fork": false,
  "url": "https://api.github.com/repos/octocat/Hello-World",
  "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
  "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
  "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
  "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
  "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
  "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
  "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
  "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
  "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
  "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
  "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
  "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
  "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
  "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
  "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
  "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
  "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
  "git_url": "git:github.com/octocat/Hello-World.git",
  "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
  "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
  "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
  "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
  "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
  "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
  "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
  "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
  "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
  "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
  "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
  "ssh_url": "git@github.com:octocat/Hello-World.git",
  "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
  "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
  "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
  "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
  "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
  "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
  "trees_url": "https://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": "https://api.github.com/repos/octocat/Hello-World/hooks",
  "svn_url": "https://svn.github.com/octocat/Hello-World",
  "homepage": "https://github.com",
  "language": null,
  "forks_count": 9,
  "stargazers_count": 80,
  "watchers_count": 80,
  "size": 108,
  "default_branch": "master",
  "open_issues_count": 0,
  "is_template": false,
  "topics": [
    "octocat",
    "atom",
    "electron",
    "api"
  ],
  "has_issues": true,
  "has_projects": true,
  "has_wiki": true,
  "has_pages": false,
  "has_downloads": true,
  "archived": false,
  "disabled": false,
  "visibility": "public",
  "pushed_at": "2011-01-26T19:06:43Z",
  "created_at": "2011-01-26T19:01:12Z",
  "updated_at": "2011-01-26T19:14:43Z",
  "permissions": {
    "admin": false,
    "maintain": false,
    "push": false,
    "triage": false,
    "pull": true
  },
  "role_name": "read",
  "allow_rebase_merge": true,
  "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
  "allow_squash_merge": true,
  "allow_auto_merge": false,
  "delete_branch_on_merge": true,
  "allow_merge_commit": true,
  "subscribers_count": 42,
  "network_count": 0,
  "license": {
    "key": "mit",
    "name": "MIT License",
    "url": "https://api.github.com/licenses/mit",
    "spdx_id": "MIT",
    "node_id": "MDc6TGljZW5zZW1pdA==",
    "html_url": "https://api.github.com/licenses/mit"
  },
  "forks": 1,
  "open_issues": 1,
  "watchers": 1
}

Request

Response

Errors