GitHub: List teams that are assigned to an organization role
GitHub orgs.orgsListOrgRoleTeams: arguments, response, policy and SDK examples.
← Orgs operations · Get started
Operation github.orgs_list_org_role_teams
Provider route: GET /orgs/{org}/organization-roles/{role_id}/teams. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { GitHubIntegration } from "@alter-ai/github";
async function execute(input: Parameters<GitHubIntegration["orgs"]["orgsListOrgRoleTeams"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.orgs.orgsListOrgRoleTeams(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_github import GitHubIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.orgs.orgs_list_org_role_teams(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.org | string | Required within parent | |
path.role_id | integer | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.per_page | integer | Optional | Default: 30 |
query.page | integer | Optional | Default: 1 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | array | Root | List of teams assigned to the organization role |
$[] | Model | Each item | Expand List teams that are assigned to an organization role — response body — item |
Referenced models: List teams that are assigned to an organization role — response body — item
Schemas
Section titled “Schemas”List teams that are assigned to an organization role — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The Relationship a Team has with a role. |
assignment | string | Optional | Determines if the team has a direct, indirect, or mixed relationship to a role Known values: direct, indirect, mixed |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
enterprise_id | JSON | Optional | |
enterprise_id (anyOf 1) | integer | Alternative | Unique identifier of the enterprise to which this team belongs |
enterprise_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
members_url | string | Required within parent | |
name | string | Required within parent | |
node_id | string | Required within parent | |
notification_setting | string | Optional | |
organization_id | JSON | Optional | |
organization_id (anyOf 1) | integer | Alternative | Unique identifier of the organization to which this team belongs |
organization_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
parent | Model | Required within parent | Expand Create a team — response body — parent |
permission | string | Required within parent | |
permissions | object | Optional | |
permissions.admin | boolean | Required within parent | |
permissions.maintain | boolean | Required within parent | |
permissions.pull | boolean | Required within parent | |
permissions.push | boolean | Required within parent | |
permissions.triage | boolean | Required within parent | |
privacy | string | Optional | |
repositories_url | string | Required within parent | Format: uri |
slug | string | Required within parent | |
type | string | Required within parent | The ownership type of the team Known values: enterprise, organization |
url | string | Required within parent | Format: uri |
Referenced models: Create a team — response body — parent
Create a team — response body — parent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Create a team — response body — parent / type: enterprise, organization |
$ (anyOf 2) | null | Alternative |
Referenced models: Create a team — response body — parent / type: enterprise, organization
Create a team — response body — parent / type: enterprise, organization
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Groups of organization members that gives permissions on specified repositories. |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Description of the team |
description (anyOf 2) | null | Alternative | |
enterprise_id | JSON | Optional | |
enterprise_id (anyOf 1) | integer | Alternative | Unique identifier of the enterprise to which this team belongs |
enterprise_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the team |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ldap_dn | string | Optional | Distinguished Name (DN) that team maps to within LDAP environment |
members_url | string | Required within parent | |
name | string | Required within parent | Name of the team |
node_id | string | Required within parent | |
notification_setting | string | Optional | The notification setting the team has set |
organization_id | JSON | Optional | |
organization_id (anyOf 1) | integer | Alternative | Unique identifier of the organization to which this team belongs |
organization_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
permission | string | Required within parent | Permission that the team will have for its repositories |
privacy | string | Optional | The level of privacy this team should have |
repositories_url | string | Required within parent | Format: uri |
slug | string | Required within parent | |
type | string | Required within parent | The ownership type of the team Known values: enterprise, organization |
url | string | Required within parent | URL for the team Format: uri |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: github.orgs_list_org_role_teams. Catalog operation: orgs/list-org-role-teams. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}