Skip to content
forgit api docs

List enterprise teams

GET
/enterprises/{enterprise}/teams

List all teams in the enterprise for the authenticated user

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
enterprise
required
string

The slug version of the enterprise name.

Query Parameters

Section titled “ Query Parameters ”
per_page
integer
default: 30

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

page
integer
default: 1

The page number of the results to fetch. For more information, see “Using pagination in the REST API.”

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Array<object>
Enterprise Team

Group of enterprise owners and/or members

object
id
required
integer format: int64
name
required
string
description
string
slug
required
string
url
required
string format: uri
sync_to_organizations

Retired: this field will not be returned with GHEC enterprise teams.

string
organization_selection_type
string
group_id
required
string
nullable
group_name

Retired: this field will not be returned with GHEC enterprise teams.

string
nullable
html_url
required
string format: uri
members_url
required
string
created_at
required
string format: date-time
updated_at
required
string format: date-time
notification_setting

Whether team members will receive notifications when the team is mentioned.

string
Allowed values: notifications_enabled notifications_disabled
Examples
Example default 
[
  {
    "id": 1,
    "name": "Justice League",
    "description": "A great team.",
    "slug": "justice-league",
    "url": "https://api.github.com/enterprises/dc/teams/justice-league",
    "group_id": "62ab9291-fae2-468e-974b-7e45096d5021",
    "html_url": "https://github.com/enterprises/dc/teams/justice-league",
    "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}",
    "created_at": "2019-01-26T19:01:12Z",
    "updated_at": "2019-01-26T19:14:43Z"
  }
]

Headers

Section titled “ Headers ”
Link
string
Example 
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"

403

Section titled “ 403 ”

Forbidden

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}