GitHub: Get Copilot seat information and settings for an organization

← Copilot operations · Get started

Operation github.copilot_get_copilot_organization_details

Provider route: GET /orgs/{org}/copilot/billing. Alter supplies the connection’s credentials and routing.

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["copilot"]["copilotGetCopilotOrganizationDetails"]>[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.copilot.copilotGetCopilotOrganizationDetails(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from 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.copilot.copilot_get_copilot_organization_details(arguments)
        result = await call.wait()
        return result.body_json()

Input

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

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
$	Model	Root	Expand Get Copilot seat information and settings for an organization — response body

Referenced models: Get Copilot seat information and settings for an organization — response body

Schemas

Get Copilot seat information and settings for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root	Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. Additional keys: allowed
cli	string	Optional	The organization policy for allowing or disallowing Copilot CLI. Known values: enabled, disabled, unconfigured
ide_chat	string	Optional	The organization policy for allowing or disallowing Copilot Chat in the IDE. Known values: enabled, disabled, unconfigured
plan_type	string	Optional	The Copilot plan of the organization, or the parent enterprise, when applicable. Known values: business, enterprise, access
platform_chat	string	Optional	The organization policy for allowing or disallowing Copilot features on GitHub.com. Known values: enabled, disabled, unconfigured
public_code_suggestions	string	Required within parent	The organization policy for allowing or blocking suggestions matching public code (duplication detection filter). Known values: allow, block, unconfigured
seat_breakdown	Model	Required within parent	Expand Get Copilot seat information and settings for an organization — response body — seat breakdown
seat_management_setting	string	Required within parent	The mode of assigning new seats. Known values: assign_all, assign_selected, disabled, unconfigured

Referenced models: Get Copilot seat information and settings for an organization — response body — seat breakdown

Get Copilot seat information and settings for an organization — response body — seat breakdown

Field	Type	Presence	Description and constraints
$	object	Root	The breakdown of Copilot Business seats for the organization.
active_this_cycle	JSON	Optional
active_this_cycle (anyOf 1)	integer	Alternative	The number of seats that have used Copilot during the current billing cycle.
active_this_cycle (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
added_this_cycle	JSON	Optional
added_this_cycle (anyOf 1)	integer	Alternative	Seats added during the current billing cycle.
added_this_cycle (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
inactive_this_cycle	JSON	Optional
inactive_this_cycle (anyOf 1)	integer	Alternative	The number of seats that have not used Copilot during the current billing cycle.
inactive_this_cycle (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pending_cancellation	JSON	Optional
pending_cancellation (anyOf 1)	integer	Alternative	The number of seats that are pending cancellation at the end of the current billing cycle.
pending_cancellation (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pending_invitation	JSON	Optional
pending_invitation (anyOf 1)	integer	Alternative	The number of users who have been invited to receive a Copilot seat through this organization.
pending_invitation (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total	JSON	Optional
total (anyOf 1)	integer	Alternative	The total number of seats being billed for the organization as of the current billing cycle.
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: github.copilot_get_copilot_organization_details. Catalog operation: copilot/get-copilot-organization-details. 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"}

Official provider source