Get a team (Legacy) | Sample

1 parameter

team_idintegerrequired

The unique identifier of the team.

2 status codes

200Response

idintegerrequired

Unique identifier of the team

node_idstringrequired

urlstringrequired

URL for the team

html_urlstringrequired

namestringrequired

Name of the team

slugstringrequired

descriptionstringrequired

privacystringoptional

The level of privacy this team should have

Allowed:closedsecret

notification_settingstringoptional

The notification setting the team has set

Allowed:notifications_enablednotifications_disabled

permissionstringrequired

Permission that the team will have for its repositories

members_urlstringrequired

repositories_urlstringrequired

parentobjectoptional

Groups of organization members that gives permissions on specified repositories.

members_countintegerrequired

repos_countintegerrequired

created_atstringrequired

updated_atstringrequired

organizationobjectrequired

Team Organization

ldap_dnstringoptional

The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.

typestringrequired

The ownership type of the team

Allowed:enterpriseorganization

organization_idintegeroptional

Unique identifier of the organization to which this team belongs

enterprise_idintegeroptional

Unique identifier of the enterprise to which this team belongs

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.get({ teamId: "c0a80123-4567-89ab-cdef-0123456789ab" });

{
  "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,
  "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",
    "is_verified": true,
    "has_organization_projects": true,
    "has_repository_projects": true,
    "public_repos": 2,
    "public_gists": 1,
    "followers": 20,
    "following": 0,
    "html_url": "https://github.com/octocat",
    "created_at": "2008-01-14T04:33:35Z",
    "updated_at": "2017-08-17T12:37:15Z",
    "type": "Organization"
  }
}

Was this helpful?

Request

Response

Errors