GitHub · Schema

GitHub Organization

A GitHub organization that groups users and repositories together under shared ownership, permissions, and policies.

CodePipelinesPlatformSoftware DevelopmentSource ControlT1

Properties

Name Type Description
login string The login name of the organization.
id integer The unique identifier of the organization.
node_id string The GraphQL node ID for the organization.
url string The API URL for the organization.
html_url string The URL of the organization on GitHub.
repos_url string API URL for the organization's repositories.
events_url string API URL for the organization's events.
hooks_url string API URL for the organization's webhooks.
issues_url string API URL for the organization's issues.
members_url string API URL template for the organization's members.
public_members_url string API URL template for the organization's public members.
avatar_url string URL to the organization's avatar image.
description stringnull A description of the organization.
name stringnull The display name of the organization.
company stringnull The company name associated with the organization.
blog stringnull The organization's blog or website URL.
location stringnull The organization's location.
email stringnull The organization's publicly visible email address.
twitter_username stringnull The organization's Twitter/X username.
is_verified boolean Whether the organization has verified its domain.
has_organization_projects boolean Whether the organization has projects enabled.
has_repository_projects boolean Whether repositories can have projects enabled.
public_repos integer The number of public repositories.
public_gists integer The number of public gists.
followers integer The number of followers.
following integer The number of users the organization is following.
type string The account type.
created_at string The date and time the organization was created.
updated_at string The date and time the organization was last updated.
plan object
default_repository_permission string The default permission level for new repositories.
members_can_create_repositories boolean Whether members can create repositories.
members_can_create_public_repositories boolean Whether members can create public repositories.
members_can_create_private_repositories boolean Whether members can create private repositories.
two_factor_requirement_enabled boolean Whether two-factor authentication is required for members.
total_private_repos integer The total number of private repositories.
owned_private_repos integer The number of private repositories owned by the organization.
View JSON Schema on GitHub

JSON Schema

github-organization-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/schemas/github/organization.json",
  "title": "GitHub Organization",
  "description": "A GitHub organization that groups users and repositories together under shared ownership, permissions, and policies.",
  "type": "object",
  "required": ["login", "id"],
  "properties": {
    "login": {
      "type": "string",
      "description": "The login name of the organization."
    },
    "id": {
      "type": "integer",
      "description": "The unique identifier of the organization."
    },
    "node_id": {
      "type": "string",
      "description": "The GraphQL node ID for the organization."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The API URL for the organization."
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the organization on GitHub."
    },
    "repos_url": {
      "type": "string",
      "format": "uri",
      "description": "API URL for the organization's repositories."
    },
    "events_url": {
      "type": "string",
      "format": "uri",
      "description": "API URL for the organization's events."
    },
    "hooks_url": {
      "type": "string",
      "format": "uri",
      "description": "API URL for the organization's webhooks."
    },
    "issues_url": {
      "type": "string",
      "format": "uri",
      "description": "API URL for the organization's issues."
    },
    "members_url": {
      "type": "string",
      "description": "API URL template for the organization's members."
    },
    "public_members_url": {
      "type": "string",
      "description": "API URL template for the organization's public members."
    },
    "avatar_url": {
      "type": "string",
      "format": "uri",
      "description": "URL to the organization's avatar image."
    },
    "description": {
      "type": ["string", "null"],
      "description": "A description of the organization."
    },
    "name": {
      "type": ["string", "null"],
      "description": "The display name of the organization."
    },
    "company": {
      "type": ["string", "null"],
      "description": "The company name associated with the organization."
    },
    "blog": {
      "type": ["string", "null"],
      "description": "The organization's blog or website URL."
    },
    "location": {
      "type": ["string", "null"],
      "description": "The organization's location."
    },
    "email": {
      "type": ["string", "null"],
      "format": "email",
      "description": "The organization's publicly visible email address."
    },
    "twitter_username": {
      "type": ["string", "null"],
      "description": "The organization's Twitter/X username."
    },
    "is_verified": {
      "type": "boolean",
      "description": "Whether the organization has verified its domain."
    },
    "has_organization_projects": {
      "type": "boolean",
      "description": "Whether the organization has projects enabled."
    },
    "has_repository_projects": {
      "type": "boolean",
      "description": "Whether repositories can have projects enabled."
    },
    "public_repos": {
      "type": "integer",
      "minimum": 0,
      "description": "The number of public repositories."
    },
    "public_gists": {
      "type": "integer",
      "minimum": 0,
      "description": "The number of public gists."
    },
    "followers": {
      "type": "integer",
      "minimum": 0,
      "description": "The number of followers."
    },
    "following": {
      "type": "integer",
      "minimum": 0,
      "description": "The number of users the organization is following."
    },
    "type": {
      "type": "string",
      "const": "Organization",
      "description": "The account type."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the organization was created."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the organization was last updated."
    },
    "plan": {
      "$ref": "#/$defs/Plan"
    },
    "default_repository_permission": {
      "type": "string",
      "enum": ["read", "write", "admin", "none"],
      "description": "The default permission level for new repositories."
    },
    "members_can_create_repositories": {
      "type": "boolean",
      "description": "Whether members can create repositories."
    },
    "members_can_create_public_repositories": {
      "type": "boolean",
      "description": "Whether members can create public repositories."
    },
    "members_can_create_private_repositories": {
      "type": "boolean",
      "description": "Whether members can create private repositories."
    },
    "two_factor_requirement_enabled": {
      "type": "boolean",
      "description": "Whether two-factor authentication is required for members."
    },
    "total_private_repos": {
      "type": "integer",
      "minimum": 0,
      "description": "The total number of private repositories."
    },
    "owned_private_repos": {
      "type": "integer",
      "minimum": 0,
      "description": "The number of private repositories owned by the organization."
    }
  },
  "$defs": {
    "Plan": {
      "type": "object",
      "description": "The billing plan for the organization.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the plan."
        },
        "space": {
          "type": "integer",
          "description": "The amount of disk space available in KB."
        },
        "private_repos": {
          "type": "integer",
          "description": "The number of private repos allowed."
        },
        "filled_seats": {
          "type": "integer",
          "description": "The number of filled seats."
        },
        "seats": {
          "type": "integer",
          "description": "The total number of seats available."
        }
      }
    }
  }
}