Sample - GitHub REST API
GET/orgs/{org}/teams/{team_slug}

Get a team by name

Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, "My TEam Näme" would become my-team-name.

[!NOTE] You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.

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

2 parameters
orgstringrequired
The organization name. The name is not case sensitive.
team_slugstringrequired
The slug of the team name.

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.