List all Copilot seat assignments for an organization

GET

/orgs/{org}/copilot/billing/seats

[!NOTE] This endpoint is in public preview and is subject to change.

Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. Only organization owners can view assigned seats.

Each seat object contains information about the assigned user’s most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at. For more information about activity data, see Metrics data properties for GitHub Copilot.

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

Query Parameters

page

integer

default: 1

The page number of the results to fetch. For more information, see “Using pagination in the REST API.”

per_page

integer

default: 50

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

Responses

200

Response

application/json

object

total_seats

Total number of Copilot seats for the organization currently being billed.

integer

seats

Array<object>

Copilot Business Seat Detail

Information about a Copilot Business seat assignment for a user, team, or organization.

object

assignee

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

organization

Organization Simple

A GitHub organization.

object

login

required

string

required

integer

node_id

required

string

url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string format: uri

hooks_url

required

string

issues_url

required

string

members_url

required

string

public_members_url

required

string

avatar_url

required

string

description

required

string

nullable

assigning_team

One of:

Team
Enterprise Team

Team

Groups of organization members that gives permissions on specified repositories.

object

required

integer

node_id

required

string

name

required

string

slug

required

string

description

required

string

nullable

privacy

string

notification_setting

string

permission

required

string

permissions

object

pull

required

boolean

triage

required

boolean

push

required

boolean

maintain

required

boolean

admin

required

boolean

url

required

string format: uri

html_url

required

string format: uri

members_url

required

string

repositories_url

required

string format: uri

type

required

The ownership type of the team

string

Allowed values: enterprise organization

access_source

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.

string

Allowed values: direct organization enterprise

organization_id

Unique identifier of the organization to which this team belongs

integer

enterprise_id

Unique identifier of the enterprise to which this team belongs

integer

parent

required

Team Simple

Groups of organization members that gives permissions on specified repositories.

object

required

Unique identifier of the team

integer

node_id

required

string

url

required

URL for the team

string format: uri

members_url

required

string

name

required

Name of the team

string

description

required

Description of the team

string

nullable

permission

required

Permission that the team will have for its repositories

string

privacy

The level of privacy this team should have

string

notification_setting

The notification setting the team has set

string

html_url

required

string format: uri

repositories_url

required

string format: uri

slug

required

string

ldap_dn

Distinguished Name (DN) that team maps to within LDAP environment

string

type

required

The ownership type of the team

string

Allowed values: enterprise organization

organization_id

Unique identifier of the organization to which this team belongs

integer

enterprise_id

Unique identifier of the enterprise to which this team belongs

integer

pending_cancellation_date

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.

string format: date

nullable

last_activity_at

Timestamp of user’s last GitHub Copilot activity, in ISO 8601 format.

string format: date-time

nullable

last_activity_editor

Last editor that was used by the user for a GitHub Copilot completion.

string

nullable

last_authenticated_at

Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format.

string format: date-time

nullable

created_at

required

Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format.

string format: date-time

updated_at

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.

string format: date-time

plan_type

The Copilot plan of the organization, or the parent enterprise, when applicable.

string

Allowed values: business enterprise unknown

Examples

default

{
  "total_seats": 2,
  "seats": [
    {
      "created_at": "2021-08-03T18:00:00-06:00",
      "updated_at": "2021-09-23T15:00:00-06:00",
      "pending_cancellation_date": null,
      "last_activity_at": "2021-10-14T00:53:32-06:00",
      "last_activity_editor": "vscode/1.77.3/copilot/1.86.82",
      "last_authenticated_at": "2021-10-14T00:53:32-06:00",
      "plan_type": "business",
      "assignee": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "assigning_team": {
        "id": 1,
        "node_id": "MDQ6VGVhbTE=",
        "url": "https://api.github.com/teams/1",
        "html_url": "https://github.com/orgs/github/teams/justice-league",
        "name": "Justice League",
        "slug": "justice-league",
        "description": "A great team.",
        "privacy": "closed",
        "notification_setting": "notifications_enabled",
        "permission": "admin",
        "members_url": "https://api.github.com/teams/1/members{/member}",
        "repositories_url": "https://api.github.com/teams/1/repos",
        "parent": null
      }
    },
    {
      "created_at": "2021-09-23T18:00:00-06:00",
      "updated_at": "2021-09-23T15:00:00-06:00",
      "pending_cancellation_date": "2021-11-01",
      "last_activity_at": "2021-10-13T00:53:32-06:00",
      "last_activity_editor": "vscode/1.77.3/copilot/1.86.82",
      "last_authenticated_at": "2021-10-14T00:53:32-06:00",
      "assignee": {
        "login": "octokitten",
        "id": 1,
        "node_id": "MDQ76VNlcjE=",
        "avatar_url": "https://github.com/images/error/octokitten_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octokitten",
        "html_url": "https://github.com/octokitten",
        "followers_url": "https://api.github.com/users/octokitten/followers",
        "following_url": "https://api.github.com/users/octokitten/following{/other_user}",
        "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions",
        "organizations_url": "https://api.github.com/users/octokitten/orgs",
        "repos_url": "https://api.github.com/users/octokitten/repos",
        "events_url": "https://api.github.com/users/octokitten/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octokitten/received_events",
        "type": "User",
        "site_admin": false
      }
    }
  ]
}

Headers

Link

string

Example

<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"

401

Requires authentication

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

403

Forbidden

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

500

Internal Error

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

List all Copilot seat assignments for an organization

Parameters

Path Parameters

Query Parameters

Responses

200

Examples

Headers

Example

401

Example generated

403

Example generated

404

Example generated

500

Example generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated