Skip to content
forgit api docs

List organization Copilot Spaces

GET
/orgs/{org}/copilot-spaces

Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization’s Copilot Spaces.

Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
org
required
string

The organization name. The name is not case sensitive.

Query Parameters

Section titled “ Query Parameters ”
per_page
integer
default: 30 >= 1 <= 100

The number of results per page (max 100).

before
string

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.

after
string

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
object
spaces
required

The list of Copilot Spaces on this page of results.

Array<object>
Space

A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.

object
id
required

The unique identifier of the space.

integer format: int64
number
required

The number that identifies the space within its owner.

integer
name
required

The display name of the space.

string
description

A description of the space.

string
nullable
general_instructions

General instructions for the Copilot Space.

string
nullable <= 4000 characters
base_role
required

The base role that determines default permissions.

  • no_access: No default access
  • reader: Default read permissions
  • writer: Default write permissions (organization spaces only)
  • admin: Default admin permissions (organization spaces only)
string
Allowed values: reader writer admin no_access
owner
required
Any of:
Simple User

A GitHub user.

object
name
string
nullable
email
string
nullable
login
required
string
id
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
creator
required
Simple User

A GitHub user.

object
name
string
nullable
email
string
nullable
login
required
string
id
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
created_at
required

The date and time the space was created.

string format: date-time
updated_at
required

The date and time the space was last updated.

string format: date-time
html_url
required

The HTML URL of the space.

string format: uri
api_url
required

The API URL of the space.

string format: uri
resources_attributes

Resources attached to the space.

Array<object>
object
id

The unique identifier of the resource.

integer format: int64
resource_type

The type of resource.

string
Allowed values: repository github_file free_text github_issue github_pull_request media_content uploaded_text_file
copilot_chat_attachment_id

The unique identifier of the chat attachment for uploaded files or media content.

integer format: int64
nullable
created_at

The date and time the resource was created.

string format: date-time
updated_at

The date and time the resource was last updated.

string format: date-time
metadata

Metadata specific to the resource type.

object
repository_id

Repository ID for repository or file resources.

integer
file_path

File path for file resources.

string
text

Text content for free text resources.

string
name

Name for the resource.

string
number

Issue or PR number.

integer
copilot_chat_attachment_id

Chat attachment ID for uploaded files or media.

integer
media_type

Media type for media content resources.

string
url

URL for media content resources.

string
height

Height for media content resources.

integer
width

Width for media content resources.

integer
Examples
Example default

Example response for listing organization copilot spaces 

{
  "spaces": [
    {
      "id": 84,
      "number": 3,
      "name": "Team Planning Space",
      "description": "Organization space for team planning and coordination",
      "owner": {
        "login": "octo-org",
        "id": 1,
        "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
        "url": "https://api.github.com/orgs/octo-org",
        "repos_url": "https://api.github.com/orgs/octo-org/repos",
        "events_url": "https://api.github.com/orgs/octo-org/events",
        "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
        "issues_url": "https://api.github.com/orgs/octo-org/issues",
        "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
        "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "description": "A great organization",
        "gravatar_id": "",
        "name": "octo-org",
        "company": "GitHub",
        "blog": "https://github.com/blog",
        "location": "San Francisco",
        "email": "octocat@github.com",
        "twitter_username": "octo-org",
        "html_url": "https://github.com/octo-org",
        "created_at": "2008-01-14T04:33:35Z",
        "updated_at": "2017-08-17T12:37:15Z",
        "type": "Organization"
      },
      "creator": {
        "login": "defunkt",
        "id": 2,
        "node_id": "MDQ6VXNlcjI=",
        "avatar_url": "https://github.com/images/error/defunkt_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/defunkt",
        "html_url": "https://github.com/defunkt",
        "followers_url": "https://api.github.com/users/defunkt/followers",
        "following_url": "https://api.github.com/users/defunkt/following{/other_user}",
        "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions",
        "organizations_url": "https://api.github.com/users/defunkt/orgs",
        "repos_url": "https://api.github.com/users/defunkt/repos",
        "events_url": "https://api.github.com/users/defunkt/events{/privacy}",
        "received_events_url": "https://api.github.com/users/defunkt/received_events",
        "type": "User",
        "site_admin": true
      },
      "created_at": "2023-02-15T08:30:00Z",
      "updated_at": "2023-02-15T14:45:00Z",
      "html_url": "https://github.com/copilot/spaces/octo-org/3",
      "api_url": "https://api.github.com/organizations/1/copilot-spaces/3"
    },
    {
      "id": 85,
      "number": 4,
      "name": "Development Resources",
      "description": "Shared development documentation and resources",
      "owner": {
        "login": "octo-org",
        "id": 1,
        "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
        "url": "https://api.github.com/orgs/octo-org",
        "repos_url": "https://api.github.com/orgs/octo-org/repos",
        "events_url": "https://api.github.com/orgs/octo-org/events",
        "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
        "issues_url": "https://api.github.com/orgs/octo-org/issues",
        "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
        "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "description": "A great organization",
        "gravatar_id": "",
        "name": "octo-org",
        "company": "GitHub",
        "blog": "https://github.com/blog",
        "location": "San Francisco",
        "email": "octocat@github.com",
        "twitter_username": "octo-org",
        "html_url": "https://github.com/octo-org",
        "created_at": "2008-01-14T04:33:35Z",
        "updated_at": "2017-08-17T12:37:15Z",
        "type": "Organization"
      },
      "creator": {
        "login": "octocat",
        "id": 3,
        "node_id": "MDQ6VXNlcjM=",
        "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
      },
      "created_at": "2023-02-16T10:15:00Z",
      "updated_at": "2023-02-16T16:30:00Z",
      "html_url": "https://github.com/copilot/spaces/octo-org/4",
      "api_url": "https://api.github.com/organizations/1/copilot-spaces/4"
    }
  ]
}

Headers

Section titled “ Headers ”
Link
string
Example 
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"

403

Section titled “ 403 ”

Forbidden

Media type 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

Section titled “ 404 ”

Resource not found

Media type 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"
}