Sample - GitHub REST API
POST/orgs/{org}/copilot-spaces/{space_number}/collaborators

Add a collaborator to an organization Copilot Space

Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

Note: When adding users as collaborators, they must already be members of the organization. When adding teams as collaborators, they must be defined in the organization.

OAuth app tokens and personal access tokens (classic) need the write: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 the space.

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

2 parameters · 3 body fields
orgstringrequired
The organization name. The name is not case sensitive.
space_numberintegerrequired
The unique identifier of the Copilot Space.
actor_typestringrequired
The type of actor (user or team).
Allowed:UserTeam
actor_identifierstringrequired
The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.
rolestringrequired
The role to grant to the collaborator.
Allowed:readerwriteradmin

4 status codes
201Response
namestringoptional
emailstringoptional
loginstringrequired
idintegerrequired
node_idstringrequired
avatar_urlstringrequired
gravatar_idstringrequired
urlstringrequired
html_urlstringrequired
followers_urlstringrequired
following_urlstringrequired
gists_urlstringrequired
starred_urlstringrequired
subscriptions_urlstringrequired
organizations_urlstringrequired
repos_urlstringrequired
events_urlstringrequired
received_events_urlstringrequired
typestringrequired
site_adminbooleanrequired
starred_atstringoptional
user_view_typestringoptional
actor_typestringrequired
The collaborator actor type.
Allowed:User
rolestringrequired
The role granted to the collaborator
Allowed:readerwriteradmin
403Forbidden
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Validation failed, or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<object>optional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed.