Skip to content

GitHub: Copilot schemas

15 GitHub schemas with complete fields and constraints.

← Copilot operations · All schemas

Get Copilot code review settings for a repository — response body

FieldTypePresenceDescription and constraints
$objectRootThe repository's Copilot code review settings. These settings tune reviews; they do not enable Copilot code review.
available_review_effortsarrayRequired within parentThe review efforts that can currently be set for this repository, in display order.
available_review_efforts[]stringEach item
custom_instructions_enabledbooleanRequired within parentWhether reviews use the repository's custom instructions.
mcp_enabledbooleanRequired within parentWhether reviews can use MCP servers.
review_effortModelRequired within parentExpand Get Copilot code review settings for a repository — response body — review effort
severity_filterstringRequired within parentWhich review comment severities Copilot code review leaves out. `no_filter` keeps every comment, `low` leaves out low-severity comments, and `low_and_medium` leaves out low- and medium-severity comments.
Known values: no_filter, low, low_and_medium

Referenced models: Get Copilot code review settings for a repository — response body — review effort

Get Copilot code review settings for a repository — response body — review effort

FieldTypePresenceDescription and constraints
$objectRootThe review effort for the repository. For more information, see [Review effort level](https://docs.github.com/copilot/concepts/agent-capabilities/agent-powered-workflows-and-operations/code-review#review-effort-level).
configuredJSONRequired within parent
configured (anyOf 1)stringAlternativeThe review effort stored for the repository. Null means the repository inherits the default, or has stored a value that is not currently available.
configured (anyOf 2)nullAlternative
effectivestringRequired within parentThe review effort reviews use when the requester and the pull request do not choose one. When that effort is not currently available for the repository, this reports the effort reviews would use without it.

Get Copilot code review settings for an organization — response body

FieldTypePresenceDescription and constraints
$objectRootThe organization's Copilot code review settings.
available_review_effortsarrayRequired within parentThe review efforts that can currently be set for this organization, in display order.
available_review_efforts[]stringEach item
default_review_effortobjectRequired within parentThe default review effort for repositories in the organization that do not choose their own. For more information, see [Review effort level](https://docs.github.com/copilot/concepts/agent-capabilities/agent-powered-workflows-and-operations/code-review#review-effort-level).
default_review_effort.configuredJSONRequired within parent
default_review_effort.configured (anyOf 1)stringAlternativeThe review effort stored for the organization. Null means the organization inherits the default, or has stored a value that is not currently available.
default_review_effort.configured (anyOf 2)nullAlternative
default_review_effort.editablebooleanRequired within parentWhether organization administrators can update the setting.
default_review_effort.effectivestringRequired within parentThe review effort that repositories without their own setting use. When that effort is not currently available for the organization, this reports the fallback effort instead.
default_review_effort.github_defaultstringRequired within parentThe review effort the organization inherits when it does not configure one. This is the enterprise default when one applies, otherwise GitHub's default.
default_review_effort.managed_bystringRequired within parentWhether the enterprise or the organization controls the setting.
Known values: enterprise, organization

Get Copilot content exclusion rules for an organization — response body

FieldTypePresenceDescription and constraints
$objectRootList all Copilot Content Exclusion rules for an organization.
Additional keys: see wildcard field
$.*arrayAdditional keys
$.*[]stringEach itemThe path to the file that will be excluded.

Get Copilot seat assignment details for a user — response body

FieldTypePresenceDescription and constraints
$objectRootInformation about a Copilot Business seat assignment for a user, team, or organization.
Additional keys: not allowed
assigneeModelOptionalExpand Get an issue — response body — user
assigning_teamJSONOptional
assigning_team (anyOf 1)JSONAlternativeThe team through which the assignee is granted access to GitHub Copilot, if applicable.
assigning_team (anyOf 1) (anyOf 1)ModelAlternativeExpand List teams — response body — item
assigning_team (anyOf 1) (anyOf 2)ModelAlternativeExpand Get Copilot seat assignment details for a user — response body — assigning team value Enterprise Team
assigning_team (anyOf 2)nullAlternative
created_atstringRequired within parentTimestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format.
Format: date-time
last_activity_atJSONOptional
last_activity_at (anyOf 1)stringAlternativeTimestamp of user's last GitHub Copilot activity, in ISO 8601 format.
Format: date-time
last_activity_at (anyOf 2)nullAlternative
last_activity_editorJSONOptional
last_activity_editor (anyOf 1)stringAlternativeLast editor that was used by the user for a GitHub Copilot completion.
last_activity_editor (anyOf 2)nullAlternative
last_authenticated_atJSONOptional
last_authenticated_at (anyOf 1)stringAlternativeTimestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format.
Format: date-time
last_authenticated_at (anyOf 2)nullAlternative
organizationModelOptionalExpand Get Copilot seat assignment details for a user — response body — organization
pending_cancellation_dateJSONOptional
pending_cancellation_date (anyOf 1)stringAlternativeThe 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)nullAlternative
plan_typestringOptionalThe Copilot plan of the organization, or the parent enterprise, when applicable.
Known values: business, enterprise, unknown, access
updated_atstringOptional**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

FieldTypePresenceDescription and constraints
$objectRootGroup of enterprise owners and/or members
created_atstringRequired within parentFormat: date-time
descriptionstringOptional
group_idJSONRequired within parent
group_id (anyOf 1)stringAlternative
group_id (anyOf 2)nullAlternative
group_nameJSONOptional
group_name (anyOf 1)stringAlternativeRetired: this field will not be returned with GHEC enterprise teams.
group_name (anyOf 2)nullAlternative
html_urlstringRequired within parentFormat: uri
idJSONRequired within parent
id (anyOf 1)integerAlternativeFormat: int64
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
members_urlstringRequired within parent
namestringRequired within parent
notification_settingstringOptionalWhether team members will receive notifications when the team is mentioned.
Known values: notifications_enabled, notifications_disabled
organization_selection_typestringOptional
slugstringRequired within parent
sync_to_organizationsstringOptionalRetired: this field will not be returned with GHEC enterprise teams.
updated_atstringRequired within parentFormat: date-time
urlstringRequired within parentFormat: uri

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Get Copilot seat assignment details for a user — response body — organization A Git Hub organization
$ (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootA GitHub organization.
avatar_urlstringRequired within parent
descriptionJSONRequired within parent
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
events_urlstringRequired within parentFormat: uri
hooks_urlstringRequired within parent
idJSONRequired within parent
id (anyOf 1)integerAlternative
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issues_urlstringRequired within parent
loginstringRequired within parent
members_urlstringRequired within parent
node_idstringRequired within parent
public_members_urlstringRequired within parent
repos_urlstringRequired within parentFormat: uri
urlstringRequired within parentFormat: uri

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

FieldTypePresenceDescription and constraints
$objectRootInformation about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.
Additional keys: allowed
clistringOptionalThe organization policy for allowing or disallowing Copilot CLI.
Known values: enabled, disabled, unconfigured
ide_chatstringOptionalThe organization policy for allowing or disallowing Copilot Chat in the IDE.
Known values: enabled, disabled, unconfigured
plan_typestringOptionalThe Copilot plan of the organization, or the parent enterprise, when applicable.
Known values: business, enterprise, access
platform_chatstringOptionalThe organization policy for allowing or disallowing Copilot features on GitHub.com.
Known values: enabled, disabled, unconfigured
public_code_suggestionsstringRequired within parentThe organization policy for allowing or blocking suggestions matching public code (duplication detection filter).
Known values: allow, block, unconfigured
seat_breakdownModelRequired within parentExpand Get Copilot seat information and settings for an organization — response body — seat breakdown
seat_management_settingstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootThe breakdown of Copilot Business seats for the organization.
active_this_cycleJSONOptional
active_this_cycle (anyOf 1)integerAlternativeThe number of seats that have used Copilot during the current billing cycle.
active_this_cycle (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
added_this_cycleJSONOptional
added_this_cycle (anyOf 1)integerAlternativeSeats added during the current billing cycle.
added_this_cycle (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
inactive_this_cycleJSONOptional
inactive_this_cycle (anyOf 1)integerAlternativeThe number of seats that have not used Copilot during the current billing cycle.
inactive_this_cycle (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pending_cancellationJSONOptional
pending_cancellation (anyOf 1)integerAlternativeThe number of seats that are pending cancellation at the end of the current billing cycle.
pending_cancellation (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pending_invitationJSONOptional
pending_invitation (anyOf 1)integerAlternativeThe number of users who have been invited to receive a Copilot seat through this organization.
pending_invitation (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalJSONOptional
total (anyOf 1)integerAlternativeThe total number of seats being billed for the organization as of the current billing cycle.
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Copilot users usage metrics for a specific day — response body

FieldTypePresenceDescription and constraints
$objectRootLinks to download the Copilot usage metrics report for an enterprise/organization for a specific day.
download_linksarrayRequired within parentThe URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day.
download_links[]stringEach itemFormat: uri
report_daystringRequired within parentThe day of the report in `YYYY-MM-DD` format.
Format: date

Get Copilot users usage metrics — response body

FieldTypePresenceDescription and constraints
$objectRootLinks to download the latest Copilot usage metrics report for an enterprise/organization.
download_linksarrayRequired within parentThe URLs to download the latest Copilot usage metrics report for the enterprise/organization.
download_links[]stringEach itemFormat: uri
report_end_daystringRequired within parentThe end date of the report period in `YYYY-MM-DD` format.
Format: date
report_start_daystringRequired within parentThe start date of the report period in `YYYY-MM-DD` format.
Format: date

Get the Copilot code review policy for an enterprise — response body

FieldTypePresenceDescription and constraints
$objectRootThe configured enterprise policy, rather than a user's effective Copilot code review access.
policy_stateJSONRequired within parent
policy_state (anyOf 1)stringAlternativeThe configured policy. Null means the enterprise has not configured a policy.
Known values: enabled_for_all_organizations, disabled_for_all_organizations, configured_by_organization_admins
policy_state (anyOf 2)nullAlternative

Get the Copilot code review policy for an organization — response body

FieldTypePresenceDescription and constraints
$objectRootThe organization's configured and effective Copilot code review policy.
configured_stateJSONRequired within parent
configured_state (anyOf 1)stringAlternativeThe policy stored for the organization. Null means the organization has not configured a policy.
Known values: enabled, disabled
configured_state (anyOf 2)nullAlternative
editablebooleanRequired within parentWhether organization administrators can update the policy.
effective_statestringRequired within parentThe policy that applies to the organization after enterprise policy is considered.
Known values: enabled, disabled
managed_bystringRequired within parentWhether the enterprise or the organization controls the policy.
Known values: enterprise, organization

Get the Copilot code review runner configuration for an organization — response body

FieldTypePresenceDescription and constraints
$objectRootThe effective runner configuration that Copilot code review uses for the organization.
allow_repository_customizationbooleanRequired within parentWhether repositories can use their own runner configuration.
configured_bystringRequired within parentWhich configuration the values come from. `code_review` means the organization has saved a Copilot code review runner configuration. `coding_agent` means it has not, and the values are inherited from the organization's Copilot coding agent runner configuration.
Known values: code_review, coding_agent
runner_group_nameJSONRequired within parent
runner_group_name (anyOf 1)stringAlternativeThe runner group used for a labeled runner, or null when none is set.
runner_group_name (anyOf 2)nullAlternative
runner_labelsarrayRequired within parentThe runner labels used for a labeled runner.
runner_labels[]stringEach item
runner_typestringRequired within parentThe type of runner. `standard` uses GitHub-hosted runners. `labeled` uses runners that match the configured labels or runner group.
Known values: standard, labeled

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.