GET/repos/{owner}/{repo}/teams

List repository teams

Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

For a public repository, a team is listed only if that team added the public repository explicitly.

OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to use this endpoint with a public repository, and repo scope to use this endpoint with a private repository.

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

4 parameters

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.

per_pageintegeroptional

The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

Default:30

pageintegeroptional

The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

Default:1

2 status codes

200Response

idintegerrequired

node_idstringrequired

namestringrequired

slugstringrequired

descriptionstringrequired

privacystringoptional

notification_settingstringoptional

permissionstringrequired

permissionsobjectoptional

urlstringrequired

html_urlstringrequired

members_urlstringrequired

repositories_urlstringrequired

typestringrequired

The ownership type of the team

Allowed:enterpriseorganization

access_sourcestringoptional

How the team's access to the repository was granted. This property is only present when the team is returned in a repository context, such as `GET /repos/{owner}/{repo}/teams`.

Allowed:directorganizationenterprise

organization_idintegeroptional

Unique identifier of the organization to which this team belongs

enterprise_idintegeroptional

Unique identifier of the enterprise to which this team belongs

parentobjectrequired

Groups of organization members that gives permissions on specified repositories.

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned: Resource not found.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.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.teams.list({
  owner: "octocat",
  repo: "hello-world",
  perPage: 20,
  page: 1,
});

[
  {
    "id": 1,
    "node_id": "MDQ6VGVhbTE=",
    "url": "https://api.github.com/teams/1",
    "html_url": "https://github.com/orgs/github/teams/justice-league",
    "name": "Justice League",
    "slug": "justice-league",
    "description": "A great team.",
    "privacy": "closed",
    "notification_setting": "notifications_enabled",
    "permission": "admin",
    "members_url": "https://api.github.com/teams/1/members{/member}",
    "repositories_url": "https://api.github.com/teams/1/repos",
    "parent": null
  }
]

Was this helpful?

Request

Response

Errors