Sign in

v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-07-147873273.9 MB
teams

List teams for the authenticated user

List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user, repo, or read:org scope when authenticating via OAuth. When using a fine-grained personal access token, the resource owner of the token must be a single organization, and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token.

get/user/teams

Query parameters

per_pageinteger

The number of results per page (max 100).

pageinteger

Page number of the results to fetch.

Response

Response

idinteger required

Unique identifier of the team

node_idstring required
urlstring uri required

URL for the team

html_urlstring uri required
namestring required

Name of the team

slugstring required
descriptionstring nullable required
privacy'closed' | 'secret'

The level of privacy this team should have

permissionstring required

Permission that the team will have for its repositories

members_urlstring required
repositories_urlstring uri required
members_countinteger required
repos_countinteger required
created_atstring date-time required
updated_atstring date-time required
ldap_dnstring

Distinguished Name (DN) that team maps to within LDAP environment

Example response

[
  {
    "id": 42,
    "node_id": "MDQ6VGVhbTE=",
    "url": "https://api.github.com/organizations/1/team/1",
    "html_url": "https://github.com/orgs/rails/teams/core",
    "name": "Developers",
    "slug": "justice-league",
    "description": "A great team.",
    "privacy": "closed",
    "permission": "push",
    "members_url": "https://api.github.com/organizations/1/team/1/members{/member}",
    "repositories_url": "https://api.github.com/organizations/1/team/1/repos",
    "parent": {
      "id": 1,
      "node_id": "MDQ6VGVhbTE=",
      "url": "https://api.github.com/organizations/1/team/1",
      "members_url": "https://api.github.com/organizations/1/team/1/members{/member}",
      "name": "Justice League",
      "description": "A great team.",
      "permission": "admin",
      "privacy": "closed",
      "html_url": "https://github.com/orgs/rails/teams/core",
      "repositories_url": "https://api.github.com/organizations/1/team/1/repos",
      "slug": "justice-league",
      "ldap_dn": "uid=example,ou=users,dc=github,dc=com"
    },
    "members_count": 3,
    "repos_count": 10,
    "created_at": "2017-07-14T16:53:42Z",
    "updated_at": "2017-08-17T12:37:15Z",
    "organization": {
      "login": "github",
      "id": 1,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
      "url": "https://api.github.com/orgs/github",
      "repos_url": "https://api.github.com/orgs/github/repos",
      "events_url": "https://api.github.com/orgs/github/events",
      "hooks_url": "https://api.github.com/orgs/github/hooks",
      "issues_url": "https://api.github.com/orgs/github/issues",
      "members_url": "https://api.github.com/orgs/github/members{/member}",
      "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "description": "A great organization",
      "name": "github",
      "company": "GitHub",
      "blog": "https://github.com/blog",
      "location": "San Francisco",
      "email": "octocat@github.com",
      "twitter_username": "github",
      "is_verified": true,
      "has_organization_projects": true,
      "has_repository_projects": true,
      "public_repos": 2,
      "public_gists": 1,
      "followers": 20,
      "html_url": "https://github.com/octocat",
      "created_at": "2008-01-14T04:33:35Z",
      "type": "Organization",
      "total_private_repos": 100,
      "owned_private_repos": 100,
      "private_gists": 81,
      "disk_usage": 10000,
      "collaborators": 8,
      "billing_email": "org@example.com",
      "members_can_create_repositories": true,
      "two_factor_requirement_enabled": true,
      "members_allowed_repository_creation_type": "all",
      "members_can_create_public_repositories": true,
      "members_can_create_private_repositories": true,
      "members_can_create_internal_repositories": true,
      "members_can_create_pages": true,
      "members_can_create_public_pages": true,
      "members_can_create_private_pages": true
    },
    "ldap_dn": "uid=example,ou=users,dc=github,dc=com"
  }
]