Skip to main content
Manja / GitHub

Get an organization

To 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](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See "[Authenticating with GitHub Apps](https://docs.github.com/[email protected]/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below."

GET/orgs/{org}
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
org string
required

Responses

application/json Organization Full object

Response

avatar_url string
required

Example: https://github.com/images/error/octocat_happy.gif

billing_email string<email>
optionalnullable

Example: [email protected]

blog string<uri>
optional

Example: https://github.com/blog

collaborators integer
optionalnullable

Example: 8

company string
optional

Example: GitHub

created_at string<date-time>
required

Example: 2008-01-14T04:33:35Z

default_repository_permission string
optionalnullable
description string
requirednullable

Example: A great organization

disk_usage integer
optionalnullable

Example: 10000

email string<email>
optional

Example: [email protected]

events_url string<uri>
required

Example: https://api.github.com/orgs/github/events

followers integer
required

Example: 20

following integer
required

Example: 0

has_organization_projects boolean
required

Example: true

has_repository_projects boolean
required

Example: true

hooks_url string
required

Example: https://api.github.com/orgs/github/hooks

html_url string<uri>
required

Example: https://github.com/octocat

id integer
required

Example: 1

is_verified boolean
optional

Example: true

issues_url string
required

Example: https://api.github.com/orgs/github/issues

location string
optional

Example: San Francisco

login string
required

Example: github

members_allowed_repository_creation_type string
optional

Example: all

members_can_create_internal_repositories boolean
optional

Example: true

members_can_create_pages boolean
optional

Example: true

members_can_create_private_pages boolean
optional

Example: true

members_can_create_private_repositories boolean
optional

Example: true

members_can_create_public_pages boolean
optional

Example: true

members_can_create_public_repositories boolean
optional

Example: true

members_can_create_repositories boolean
optionalnullable

Example: true

members_can_fork_private_repositories boolean
optionalnullable

Example: false

members_url string
required

Example: https://api.github.com/orgs/github/members{/member}

name string
optional

Example: github

node_id string
required

Example: MDEyOk9yZ2FuaXphdGlvbjE=

owned_private_repos integer
optional

Example: 100

plan object
optional
filled_seats integer
optional
name string
required
private_repos integer
required
seats integer
optional
space integer
required
private_gists integer
optionalnullable

Example: 81

public_gists integer
required

Example: 1

public_members_url string
required

Example: https://api.github.com/orgs/github/public_members{/member}

public_repos integer
required

Example: 2

repos_url string<uri>
required

Example: https://api.github.com/orgs/github/repos

total_private_repos integer
optional

Example: 100

twitter_username string
optionalnullable

Example: github

two_factor_requirement_enabled boolean
optionalnullable

Example: true

type string
required

Example: Organization

updated_at string<date-time>
required
url string<uri>
required

Example: https://api.github.com/orgs/github

application/json Basic Error object

Resource not found

documentation_url string
optional
message string
optional
status string
optional
url string
optional