GitHub: Copilot schemas
9 GitHub schemas with complete fields and constraints.
← Copilot operations · All schemas
Get Copilot content exclusion rules for an organization — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List all Copilot Content Exclusion rules for an organization. Additional keys: see wildcard field |
$.* | array | Additional keys | |
$.*[] | string | Each item | The path to the file that will be excluded. |
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 Copilot seat assignment details for a user — response body — organization A Git Hub organization
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A GitHub organization. |
avatar_url | string | Required within parent | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
events_url | string | Required within parent | Format: uri |
hooks_url | string | Required within parent | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issues_url | string | Required within parent | |
login | string | Required within parent | |
members_url | string | Required within parent | |
node_id | string | Required within parent | |
public_members_url | string | Required within parent | |
repos_url | string | Required within parent | Format: uri |
url | string | Required within parent | Format: uri |
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]+)?$ |
Get Copilot users usage metrics for a specific day — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Links to download the Copilot usage metrics report for an enterprise/organization for a specific day. |
download_links | array | Required within parent | The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day. |
download_links[] | string | Each item | Format: uri |
report_day | string | Required within parent | The day of the report in `YYYY-MM-DD` format. Format: date |
Get Copilot users usage metrics — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Links to download the latest Copilot usage metrics report for an enterprise/organization. |
download_links | array | Required within parent | The URLs to download the latest Copilot usage metrics report for the enterprise/organization. |
download_links[] | string | Each item | Format: uri |
report_end_day | string | Required within parent | The end date of the report period in `YYYY-MM-DD` format. Format: date |
report_start_day | string | Required within parent | The start date of the report period in `YYYY-MM-DD` format. Format: date |