Back to GithubList discussions (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions
endpoint.
List all discussions on a team's page. OAuth access tokens require the read:discussion
scope.
Input
type: object
properties:
parameters:
type: object
properties:
team_id:
type: integer
description: The unique identifier of the team.
direction:
type: string
enum:
- asc
- desc
default: desc
description: The direction to sort the results by.
per_page:
type: integer
default: 30
description: The number of results per page (max 100).
page:
type: integer
default: 1
description: Page number of the results to fetch.
required:
- team_id
title: Parameters
Output
type: array
items:
type: object
title: Team Discussion
properties:
author:
type: object
title: Simple User
properties:
name:
nullable: true
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
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: integer
example: 0
comments_url:
type: string
format: uri
example: >-
https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
example: '2018-01-25T18:56:31.000Z'
last_edited_at:
type: string
format: date-time
nullable: true
html_url:
type: string
format: 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: integer
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 administrators.
example: true
type: boolean
team_url:
type: string
format: 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: string
format: date-time
example: '2018-01-25T18:56:31.000Z'
url:
type: string
format: uri
example: https://api.github.com/organizations/1/team/2343027/discussions/1
reactions:
type: object
title: Reaction Rollup
properties:
url:
type: string
format: uri
total_count:
type: integer
'+1':
type: integer
'-1':
type: integer
laugh:
type: integer
confused:
type: integer
heart:
type: integer
hooray:
type: integer
eyes:
type: integer
rocket:
type: integer