enterprise-teams

List enterprise teams

Changed on

List all teams in the enterprise for the authenticated user

get/enterprises/{enterprise}/teams

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/enterprises/{enterprise}/teams
  • Auth: none declared

Path parameters

enterprisestring required

The slug version of the enterprise name.

Query parameters

per_pageinteger

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

pageinteger

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

Response

Response

idinteger required
namestring required
descriptionstring
slugstring required
urlstring uri required
sync_to_organizationsstring

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

organization_selection_typestring
group_idstring nullable required
group_namestring nullable

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

html_urlstring uri required
members_urlstring required
created_atstring date-time required
updated_atstring date-time required
notification_setting'notifications_enabled' | 'notifications_disabled'

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

Example response

[
  {
    "sync_to_organizations": "disabled | all",
    "organization_selection_type": "disabled | selected | all",
    "group_id": "62ab9291-fae2-468e-974b-7e45096d5021",
    "group_name": "Justice League",
    "html_url": "https://github.com/enterprises/dc/teams/justice-league",
    "notification_setting": "notifications_enabled"
  }
]

Changes

  • 2022-11-280f10eea637deRevision changes
    • info

      added the optional property / to the response with the status