Skip to main content

orgs

Overview

Nameorgs
TypeResource
Idgithub.orgs.orgs

Fields

NameDatatype
idinteger
namestring
descriptionstring
owned_private_reposinteger
members_can_create_repositoriesboolean
two_factor_requirement_enabledboolean
members_can_create_pagesboolean
is_verifiedboolean
locationstring
private_gistsinteger
collaboratorsinteger
has_organization_projectsboolean
members_can_create_public_pagesboolean
public_members_urlstring
members_allowed_repository_creation_typestring
public_gistsinteger
html_urlstring
node_idstring
members_can_create_internal_repositoriesboolean
members_can_create_private_pagesboolean
planobject
repos_urlstring
blogstring
members_can_fork_private_repositoriesboolean
members_can_create_private_repositoriesboolean
members_urlstring
disk_usageinteger
urlstring
twitter_usernamestring
followinginteger
hooks_urlstring
events_urlstring
loginstring
avatar_urlstring
emailstring
has_repository_projectsboolean
issues_urlstring
updated_atstring
total_private_reposinteger
typestring
default_repository_permissionstring
companystring
public_reposinteger
members_can_create_public_repositoriesboolean
created_atstring
followersinteger
billing_emailstring

Methods

NameAccessible byRequired ParamsDescription
getSELECTorgTo see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub plan. See "Authenticating with GitHub Apps" for details. For an example response, see 'Response with GitHub plan information' below."
listSELECTLists all organizations, in the order that they were created on GitHub.

Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
list_for_userSELECTusernameList public organization memberships for the specified user.

This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
updateUPDATEorgParameter Deprecation Notice: GitHub will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.
list_for_authenticated_userEXECList organizations for the authenticated user.

OAuth scope requirements

This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope. OAuth requests with insufficient scope receive a 403 Forbidden response.