GitHub · JSON Structure

Github Projects Project Structure

Projects are a way to organize columns and cards of work.

Type: object Properties: 15 Required: 13

CodePipelinesPlatformSoftware DevelopmentSource ControlT1

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

Properties

owner_url url html_url columns_url id node_id name body number state creator created_at updated_at organization_permission private

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-structure/github-projects-project-structure.json",
  "name": "project",
  "description": "Projects are a way to organize columns and cards of work.",
  "type": "object",
  "properties": {
    "owner_url": {
      "type": "uri",
      "example": "https://api.github.com/repos/api-playground/projects-test"
    },
    "url": {
      "type": "uri",
      "example": "https://api.github.com/projects/1002604"
    },
    "html_url": {
      "type": "uri",
      "example": "https://github.com/api-playground/projects-test/projects/12"
    },
    "columns_url": {
      "type": "uri",
      "example": "https://api.github.com/projects/1002604/columns"
    },
    "id": {
      "type": "int32",
      "example": 1002604
    },
    "node_id": {
      "type": "string",
      "example": "MDc6UHJvamVjdDEwMDI2MDQ="
    },
    "name": {
      "description": "Name of the project",
      "example": "Week One Sprint",
      "type": "string"
    },
    "body": {
      "description": "Body of the project",
      "example": "This project represents the sprint of the first week in January",
      "type": "string",
      "nullable": true
    },
    "number": {
      "type": "int32",
      "example": 1
    },
    "state": {
      "description": "State of the project; either 'open' or 'closed'",
      "example": "open",
      "type": "string"
    },
    "creator": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "created_at": {
      "type": "datetime",
      "example": "2011-04-10T20:09:31Z"
    },
    "updated_at": {
      "type": "datetime",
      "example": "2014-03-03T18:58:10Z"
    },
    "organization_permission": {
      "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.",
      "type": "string",
      "enum": [
        "read",
        "write",
        "admin",
        "none"
      ],
      "example": "read"
    },
    "private": {
      "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.",
      "type": "boolean",
      "example": true
    }
  },
  "required": [
    "id",
    "node_id",
    "number",
    "name",
    "body",
    "state",
    "url",
    "html_url",
    "owner_url",
    "creator",
    "columns_url",
    "created_at",
    "updated_at"
  ]
}