GitHub · JSON Structure

Github Teams Team Structure

Groups of organization members that gives permissions on specified repositories.

Type: object Properties: 13 Required: 11
CodePipelinesPlatformSoftware DevelopmentSource ControlT1

team is a JSON Structure definition published by GitHub, describing 13 properties, of which 11 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id node_id name slug description privacy permission permissions url html_url members_url repositories_url parent

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-structure/github-teams-team-structure.json",
  "name": "team",
  "description": "Groups of organization members that gives permissions on specified repositories.",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "example": 42
    },
    "node_id": {
      "type": "string",
      "example": "12345678"
    },
    "name": {
      "type": "string",
      "example": "octocat"
    },
    "slug": {
      "type": "string",
      "example": "example_value"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "example": "This is an example repository"
    },
    "privacy": {
      "type": "string",
      "example": "example_value"
    },
    "permission": {
      "type": "string",
      "example": "example_value"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "pull": {
          "type": "boolean"
        },
        "triage": {
          "type": "boolean"
        },
        "push": {
          "type": "boolean"
        },
        "maintain": {
          "type": "boolean"
        },
        "admin": {
          "type": "boolean"
        }
      },
      "required": [
        "pull",
        "triage",
        "push",
        "maintain",
        "admin"
      ]
    },
    "url": {
      "type": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "html_url": {
      "type": "uri",
      "example": "https://github.com/orgs/rails/teams/core"
    },
    "members_url": {
      "type": "string",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "repositories_url": {
      "type": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "parent": {
      "$ref": "#/components/schemas/nullable-team-simple"
    }
  },
  "required": [
    "id",
    "node_id",
    "url",
    "members_url",
    "name",
    "description",
    "permission",
    "html_url",
    "repositories_url",
    "slug",
    "parent"
  ]
}