Organizations

Enterprise Cloud

Enterprise Server

Enterprise Server 3.10

Enterprise Server 3.6

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!

Help for wherever you are on your GitHub journey.

Can be one of

Name

All {{ name }} guides

{{ name }} learning paths

Actions

GitHub began rolling these changes out to enterprises on

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

Organizations - GitHub AE Docs

Use the REST API to control and manage all your GitHub AE organizations.

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

Quickstart

About GitHub's APIs

Resources in the REST API

Media types

Authenticating

Keeping API credentials secure

Troubleshooting

Libraries

Issue event types

GitHub event types

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Permissions for GitHub Apps

Overview

Using the API

Script with JavaScript

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Pagination

Building a CI server

Best practices

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

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

Branches

Protected branches

Check Runs

Check Suites

Checks

Codes of conduct

Code Scanning

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Deploy keys

Deployment branch policies

Deployments

Environments

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Global Webhooks

License

Pre-receive Environments

Users

Enterprise administration

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

Members

Outside Collaborators

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

Followers

GPG Keys

Git SSH Keys

Repository Webhook Configuration

Repository Webhook Deliveries

Repository Webhooks

Repository webhooks

Organization Simple

Lists all organizations, in the order that they were created on GitHub AE.
Note: Pagination is powered exclusively by the <code>since</code> parameter. Use the <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers">Link header</a> to get the URL for the next page of organizations.

An organization ID. Only return organizations with an ID greater than this ID.

since

The number of results per page (max 100).

per_page

List organizations

github

Medium

Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.

This field is only visible to organization owners or members of a team with the security manager role.

Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to
this organization.

This field is only visible to organization owners or members of a team with the security manager role.

Whether dependabot security updates are automatically enabled for new repositories and repositories transferred
to this organization.

This field is only visible to organization owners or members of a team with the security manager role.

Whether dependency graph is automatically enabled for new repositories and repositories transferred to this
organization.

This field is only visible to organization owners or members of a team with the security manager role.

Whether secret scanning is automatically enabled for new repositories and repositories transferred to this
organization.

This field is only visible to organization owners or members of a team with the security manager role.

An optional URL string to display to contributors who are blocked from pushing a secret.

Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.

Whether secret scanning push protection is automatically enabled for new repositories and repositories
transferred to this organization.

This field is only visible to organization owners or members of a team with the security manager role.

Organization Full

To see many of the organization response values, you need to be an authenticated organization owner with the <code>admin:org</code> scope. When the value of <code>two_factor_requirement_enabled</code> is <code>true</code>, the organization requires all members, billing managers, and outside collaborators to enable <a href="https://docs.github.com/github-ae@latest/articles/securing-your-account-with-two-factor-authentication-2fa/">two-factor authentication</a>.
GitHub Apps with the <code>Organization plan</code> permission can use this endpoint to retrieve information about an organization's GitHub AE plan. See "<a href="https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/">Authenticating with GitHub Apps</a>" for details. For an example response, see 'Response with GitHub AE plan information' below."

The organization name. The name is not case sensitive.

Get an organization

Billing email address. This address is not publicized.

billing_email

company

The publicly visible email address.

email

The Twitter username of the company.

twitter_username

location

The shorthand name of the company.

name

description

Whether an organization can use organization projects.

has_organization_projects

Whether repositories that belong to the organization can use repository projects.

has_repository_projects

Default permission level members have for organization repositories.

default_repository_permission

Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See <code>members_allowed_repository_creation_type</code> in this table for details.

members_can_create_repositories

Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "<a href="https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization">Restricting repository creation in your organization</a>" in the GitHub Help documentation.

members_can_create_internal_repositories

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "<a href="https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization">Restricting repository creation in your organization</a>" in the GitHub Help documentation.

members_can_create_private_repositories

Whether organization members can create public repositories, which are visible to anyone. For more information, see "<a href="https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization">Restricting repository creation in your organization</a>" in the GitHub Help documentation.

members_can_create_public_repositories

Parameter Deprecation Notice: GitHub AE will replace and discontinue <code>members_allowed_repository_creation_type</code> in favor of more granular permissions. The new input parameters are <code>members_can_create_public_repositories</code>, <code>members_can_create_private_repositories</code> for all organizations and <code>members_can_create_internal_repositories</code> for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the <a href="https://developer.github.com/changes/2019-12-03-internal-visibility-changes">blog post</a>.
Enables an authenticated organization owner with the <code>admin:org</code> scope or the <code>repo</code> scope to update the organization's profile and member privileges.

Update an organization