GET/users/{username}/copilot-spaces/{space_number}/collaborators

List collaborators for a Copilot Space for a user

Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

Each collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list.

Team collaborators are not supported for user-owned Copilot Spaces.

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

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters

usernamestringrequired

The handle for the GitHub user account.

space_numberintegerrequired

The unique identifier of the Copilot Space.

3 status codes

200Response

collaboratorsarray<CopilotSpaceCollaborator>required

The list of collaborators for this Copilot Space.

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.collaborators.list({
  username: "octocat",
  spaceNumber: "example",
});

{
  "collaborators": [
    {
      "actor_type": "User",
      "role": "writer",
      "login": "octocat",
      "id": 12345,
      "node_id": "MDQ6VXNlcjEyMzQ1",
      "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",
      "user_view_type": "public",
      "site_admin": false,
      "name": "The Octocat",
      "company": "GitHub",
      "blog": "https://github.com/blog",
      "location": "San Francisco",
      "email": "octocat@github.com",
      "hireable": false,
      "bio": "There once was...",
      "twitter_username": "octocat",
      "public_repos": 2,
      "public_gists": 1,
      "followers": 20,
      "following": 0,
      "created_at": "2008-01-14T04:33:35Z",
      "updated_at": "2008-01-14T04:33:35Z"
    },
    {
      "actor_type": "User",
      "role": "reader",
      "login": "github-user",
      "id": 67890,
      "node_id": "MDQ6VXNlcjY3ODkw",
      "avatar_url": "https://github.com/images/error/other_user.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/github-user",
      "html_url": "https://github.com/github-user",
      "followers_url": "https://api.github.com/users/github-user/followers",
      "following_url": "https://api.github.com/users/github-user/following{/other_user}",
      "gists_url": "https://api.github.com/users/github-user/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/github-user/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/github-user/subscriptions",
      "organizations_url": "https://api.github.com/users/github-user/orgs",
      "repos_url": "https://api.github.com/users/github-user/repos",
      "events_url": "https://api.github.com/users/github-user/events{/privacy}",
      "received_events_url": "https://api.github.com/users/github-user/received_events",
      "type": "User",
      "user_view_type": "public",
      "site_admin": false,
      "name": "GitHub User",
      "company": null,
      "blog": "",
      "location": null,
      "email": null,
      "hireable": null,
      "bio": null,
      "twitter_username": null,
      "public_repos": 5,
      "public_gists": 0,
      "followers": 10,
      "following": 5,
      "created_at": "2010-01-14T04:33:35Z",
      "updated_at": "2010-01-14T04:33:35Z"
    }
  ]
}

Was this helpful?

Request

Response

Errors