REST API endpoints for enterprise organizations

About organization administration

These endpoints are only available to authenticated site administrators. Normal users will receive a 404 response.

Note

These endpoints only support authentication using a personal access token (classic). For more information, see "Managing your personal access tokens."

Create an organization

Fine-grained access tokens for "Create an organization"

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

Parameters for "Create an organization"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Body parameters
Name, Type, Description
`login` string Required The organization's username.
`admin` string Required The login of the user who will manage this organization.
`profile_name` string The organization's display name.

HTTP response status codes for "Create an organization"

Status code	Description
`201`	Created

Code samples for "Create an organization"

Request example

post/admin/organizations

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/admin/organizations \
  -d '{"login":"github","profile_name":"GitHub, Inc.","admin":"monalisaoctocat"}'

Response

Status: 201

{
  "login": "github",
  "id": 1,
  "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
  "url": "https://HOSTNAME/orgs/github",
  "repos_url": "https://HOSTNAME/orgs/github/repos",
  "events_url": "https://HOSTNAME/orgs/github/events",
  "hooks_url": "https://HOSTNAME/orgs/github/hooks",
  "issues_url": "https://HOSTNAME/orgs/github/issues",
  "members_url": "https://HOSTNAME/orgs/github/members{/member}",
  "public_members_url": "https://HOSTNAME/orgs/github/public_members{/member}",
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "description": "A great organization"
}

Update an organization name

Fine-grained access tokens for "Update an organization name"

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

Parameters for "Update an organization name"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`org` string Required The organization name. The name is not case sensitive.

Body parameters
Name, Type, Description
`login` string Required The organization's new name.

HTTP response status codes for "Update an organization name"

Status code	Description
`202`	Accepted

Code samples for "Update an organization name"

Request example

patch/admin/organizations/{org}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/admin/organizations/ORG \
  -d '{"login":"the-new-octocats"}'

Response

Status: 202

{
  "message": "Job queued to rename organization. It may take a few minutes to complete.",
  "url": "https://<hostname>/api/v3/organizations/1"
}