GitHub: Get Copilot seat assignment details for a user

GitHub copilot.copilotGetCopilotSeatDetailsForUser: arguments, response, policy and SDK examples.

Operation github.copilot_get_copilot_seat_details_for_user

Provider route: GET /orgs/{org}/members/{username}/copilot. 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"]["copilotGetCopilotSeatDetailsForUser"]>[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.copilotGetCopilotSeatDetailsForUser(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_seat_details_for_user(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
`path.username`	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 assignment details for a user — response body

Referenced models: Get Copilot seat assignment details for a user — response body

Schemas

3 more schemas are linked from the tables above, on the schema pages.

Get Copilot seat assignment details for a user — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Information about a Copilot Business seat assignment for a user, team, or organization. Additional keys: not allowed
`assignee`	Model	Optional	Expand Get an issue — response body — user
`assigning_team`	JSON	Optional
`assigning_team (anyOf 1)`	JSON	Alternative	The team through which the assignee is granted access to GitHub Copilot, if applicable.
`assigning_team (anyOf 1) (anyOf 1)`	Model	Alternative	Expand List teams — response body — item
`assigning_team (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Get Copilot seat assignment details for a user — response body — assigning team value Enterprise Team
`assigning_team (anyOf 2)`	null	Alternative
`created_at`	string	Required within parent	Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. Format: date-time
`last_activity_at`	JSON	Optional
`last_activity_at (anyOf 1)`	string	Alternative	Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. Format: date-time
`last_activity_at (anyOf 2)`	null	Alternative
`last_activity_editor`	JSON	Optional
`last_activity_editor (anyOf 1)`	string	Alternative	Last editor that was used by the user for a GitHub Copilot completion.
`last_activity_editor (anyOf 2)`	null	Alternative
`last_authenticated_at`	JSON	Optional
`last_authenticated_at (anyOf 1)`	string	Alternative	Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format. Format: date-time
`last_authenticated_at (anyOf 2)`	null	Alternative
`organization`	Model	Optional	Expand Get Copilot seat assignment details for a user — response body — organization
`pending_cancellation_date`	JSON	Optional
`pending_cancellation_date (anyOf 1)`	string	Alternative	The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. Format: date
`pending_cancellation_date (anyOf 2)`	null	Alternative
`plan_type`	string	Optional	The Copilot plan of the organization, or the parent enterprise, when applicable. Known values: business, enterprise, unknown, access
`updated_at`	string	Optional	Closing down notice: This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. Format: date-time

Referenced models: Get Copilot seat assignment details for a user — response body — assigning team value Enterprise Team, Get Copilot seat assignment details for a user — response body — organization, Get an issue — response body — user, List teams — response body — item

Get Copilot seat assignment details for a user — response body — assigning team value Enterprise Team

Field	Type	Presence	Description and constraints
`$`	object	Root	Group of enterprise owners and/or members
`created_at`	string	Required within parent	Format: date-time
`description`	string	Optional
`group_id`	JSON	Required within parent
`group_id (anyOf 1)`	string	Alternative
`group_id (anyOf 2)`	null	Alternative
`group_name`	JSON	Optional
`group_name (anyOf 1)`	string	Alternative	Retired: this field will not be returned with GHEC enterprise teams.
`group_name (anyOf 2)`	null	Alternative
`html_url`	string	Required within parent	Format: uri
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`members_url`	string	Required within parent
`name`	string	Required within parent
`notification_setting`	string	Optional	Whether team members will receive notifications when the team is mentioned. Known values: notifications_enabled, notifications_disabled
`organization_selection_type`	string	Optional
`slug`	string	Required within parent
`sync_to_organizations`	string	Optional	Retired: this field will not be returned with GHEC enterprise teams.
`updated_at`	string	Required within parent	Format: date-time
`url`	string	Required within parent	Format: uri

Get Copilot seat assignment details for a user — response body — organization

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	Model	Alternative	Expand Get Copilot seat assignment details for a user — response body — organization A Git Hub organization
`$ (anyOf 2)`	null	Alternative

Referenced models: Get Copilot seat assignment details for a user — response body — organization A Git Hub organization

Get an issue — response body — user

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	Model	Alternative	Expand Get an issue — response body — user A Git Hub user
`$ (anyOf 2)`	null	Alternative

Referenced models: Get an issue — response body — user A Git Hub user

List teams — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root	Groups of organization members that gives permissions on specified repositories.
`access_source`	string	Optional	How the team's access to the repository was granted. This property is only present when the team is returned in a repository context, such as `GET /repos/{owner}/{repo}/teams`. Known values: direct, organization, enterprise
`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

Policy, approvals and errors

SDK function policy ID: github.copilot_get_copilot_seat_details_for_user. Catalog operation: copilot/get-copilot-seat-details-for-user. 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

Report an issue with this page