enterprise-admin

List teams that are assigned to an enterprise role

Lists the teams that are assigned to an enterprise role.

[!WARNING] This API is not available for Copilot Business for non-GHE.

To use this endpoint, the authenticated user must be one of:

An administrator for the enterprise.
A user, or a user on a team, with the fine-grained permission read_enterprise_custom_enterprise_role in the enterprise.

OAuth app tokens and personal access tokens (classic) require the read:enterprise scope to access this endpoint.

get/enterprises/{enterprise}/enterprise-roles/{role_id}/teams

Path parameters

enterprisestring required

The slug version of the enterprise name.

role_idinteger required

The unique identifier of the role.

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

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

Changed in 1 of the 54 revisions of this API.1

May 6, 20262026-03-10c4eff58d97bf1See the full diff
- ○
  added the optional property items/notification_setting to the response with the 200 status
  response-optional-property-added

Full history