Collaborators

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Actions

Enter a search term to find it in the GitHub Docs.

Collaborators - GitHub Enterprise Server 3.7 Docs

Use the REST API to add, invite, and remove collaborators from a repository.

Quickstart

About the REST API

Comparing GitHub's APIs

OpenAPI description

Getting started

Rate limits

Pagination

Libraries

Media types

Best practices

Troubleshooting

Timezones

CORS and JSONP

Issue event types

GitHub event types

Using the REST API

Authenticating

Keeping API credentials secure

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Permissions for GitHub Apps

Authentication

Script with JavaScript

Script with Ruby

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Building a CI server

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Cache

OIDC

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

OAuth Authorizations

Webhooks

Apps

Billing

Branches

Protected branches

Check Runs

Check Suites

Checks

Code Scanning

Codes of conduct

Invitations

Commits

Commit comments

Commit statuses

Dependabot

Dependency review

Dependency submission

Dependency Graph

Deploy keys

Deployment branch policies

Deployments

Environments

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Global Webhooks

LDAP

License

Management Console

Organization Pre-receive Hooks

Organizations

Pre-receive Environments

Pre-receive Hooks

Repository Pre-receive Hooks

SCIM

Users

Enterprise administration

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

OAuth authorizations

Custom Repository Roles

Members

Outside Collaborators

Security Managers

Pages

Boards

Cards

Columns

Project boards

Pulls

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release Assets

Autolinks

Forks

Git LFS

Repositories

Search

Secret scanning

Teams

Discussion comments

Discussions

External groups

Emails

Followers

GPG Keys

Git SSH Keys

SSH signing keys

Collaborator

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.
Team members will include the members of child teams.
You must authenticate using an access token with the <code>read:org</code> and <code>repo</code> scopes with push access to use this
endpoint. GitHub Apps must have the <code>members</code> organization permission and <code>metadata</code> repository permission to use this
endpoint.

The account owner of the repository. The name is not case sensitive.

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

Filter collaborators returned by their affiliation. <code>outside</code> means all outside collaborators of an organization-owned repository. <code>direct</code> means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. <code>all</code> means all collaborators the authenticated user can see.

affiliation

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

List repository collaborators

Response if user is a collaborator

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
Team members will include the members of child teams.
You must authenticate using an access token with the <code>read:org</code> and <code>repo</code> scopes with push access to use this
endpoint. GitHub Apps must have the <code>members</code> organization permission and <code>metadata</code> repository permission to use this
endpoint.

The handle for the GitHub user account.

username

Not Found if user is not a collaborator

Check if a user is a repository collaborator

The permission to grant the collaborator. Only valid on organization-owned repositories.

permission

Add a collaborator with triage permissions

Response when:
<ul>
<li>an existing collaborator is added as a collaborator</li>
<li>an organization member is added as an individual collaborator</li>
<li>an existing team member (whose team is also a repository collaborator) is added as an individual collaborator</li>
</ul>

This endpoint triggers <a href="https://docs.github.com/enterprise-server@3.7/github/managing-subscriptions-and-notifications-on-github/about-notifications">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "<a href="https://docs.github.com/enterprise-server@3.7/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits">Rate limits for the API</a>" and "<a href="https://docs.github.com/enterprise-server@3.7/rest/guides/best-practices-for-using-the-rest-api">Best practices for using the REST API</a>."
Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "<a href="https://docs.github.com/enterprise-server@3.7/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories">Enforcing repository management policies in your enterprise</a>."
For more information on permission levels, see "<a href="https://docs.github.com/enterprise-server@3.7/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization">Repository permission levels for an organization</a>". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
<pre><code>Cannot assign {member} permission of {role name}
</code></pre>
Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see "<a href="https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-rest-api#http-method">HTTP method</a>."
Updating an existing collaborator's permission level
The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.

Validation failed, or the endpoint has been spammed.

Add a repository collaborator

No Content when collaborator was removed from the repository.

Removes a collaborator from a repository.
To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
This endpoint also:
<ul>
<li>Cancels any outstanding invitations</li>
<li>Unasigns the user from any issues</li>
<li>Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.</li>
<li>Unstars the repository</li>
<li>Updates access permissions to packages</li>
</ul>
Removing a user as a collaborator has the following effects on forks:
<ul>
<li>If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.</li>
<li>If the user had their own fork of the repository, the fork will be deleted.</li>
<li>If the user still has read access to the repository, open pull requests by this user from a fork will be denied.</li>
</ul>
Note: A user can still have access to the repository through organization permissions like base repository permissions.
Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.
For more information on fork permissions, see "<a href="https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks">About permissions and visibility of forks</a>".

Remove a repository collaborator

Repository Collaborator Permission

Checks the repository permission of a collaborator. The possible repository
permissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.
Note: The <code>permission</code> attribute provides the legacy base roles of <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>, where the
<code>maintain</code> role is mapped to <code>write</code> and the <code>triage</code> role is mapped to <code>read</code>. To determine the role assigned to the
collaborator, see the <code>role_name</code> attribute, which will provide the full role name, including custom roles. The
<code>permissions</code> hash can also be used to determine which base level of access the collaborator has to the repository.