GitHub · JSON Structure

Github Teams Team Discussion Structure

A team discussion is a persistent record of a free-form conversation within a team.

Type: object Properties: 18 Required: 17
CodePipelinesPlatformSoftware DevelopmentSource ControlT1

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

Properties

author body body_html body_version comments_count comments_url created_at last_edited_at html_url node_id number pinned private team_url title updated_at url reactions

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-discussion-structure.json",
  "name": "team-discussion",
  "description": "A team discussion is a persistent record of a free-form conversation within a team.",
  "type": "object",
  "properties": {
    "author": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "body": {
      "description": "The main text of the discussion.",
      "example": "Please suggest improvements to our workflow in comments.",
      "type": "string"
    },
    "body_html": {
      "type": "string",
      "example": "<p>Hi! This is an area for us to collaborate as a team</p>"
    },
    "body_version": {
      "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
      "example": "0307116bbf7ced493b8d8a346c650b71",
      "type": "string"
    },
    "comments_count": {
      "type": "int32",
      "example": 0
    },
    "comments_url": {
      "type": "uri",
      "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
    },
    "created_at": {
      "type": "datetime",
      "example": "2018-01-25T18:56:31Z"
    },
    "last_edited_at": {
      "type": "datetime",
      "nullable": true,
      "example": "2026-04-17T12:00:00Z"
    },
    "html_url": {
      "type": "uri",
      "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
    },
    "node_id": {
      "type": "string",
      "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
    },
    "number": {
      "description": "The unique sequence number of a team discussion.",
      "example": 42,
      "type": "int32"
    },
    "pinned": {
      "description": "Whether or not this discussion should be pinned for easy retrieval.",
      "example": true,
      "type": "boolean"
    },
    "private": {
      "description": "Whether or not this discussion should be restricted to team members and organization owners.",
      "example": true,
      "type": "boolean"
    },
    "team_url": {
      "type": "uri",
      "example": "https://api.github.com/organizations/1/team/2343027"
    },
    "title": {
      "description": "The title of the discussion.",
      "example": "How can we improve our workflow?",
      "type": "string"
    },
    "updated_at": {
      "type": "datetime",
      "example": "2018-01-25T18:56:31Z"
    },
    "url": {
      "type": "uri",
      "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
    },
    "reactions": {
      "$ref": "#/components/schemas/reaction-rollup"
    }
  },
  "required": [
    "author",
    "body",
    "body_html",
    "body_version",
    "comments_count",
    "comments_url",
    "created_at",
    "last_edited_at",
    "html_url",
    "pinned",
    "private",
    "node_id",
    "number",
    "team_url",
    "title",
    "updated_at",
    "url"
  ]
}