GitHub v3 REST API

Team Discussion

object

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

authorobjectrequired

Simple User

Show Child Parameters
bodystringrequired

The main text of the discussion.

Example:Please suggest improvements to our workflow in comments.

body_htmlstringrequired

Example:<p>Hi! This is an area for us to collaborate as a team</p>

body_versionstringrequired

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

comments_countintegerrequired
comments_urlstring(uri)required

Example:https://api.github.com/organizations/1/team/2343027/discussions/1/comments

created_atstring(date-time)required

Example:2018-01-25T18:56:31Z

last_edited_atstring(date-time)required
html_urlstring(uri)required

Example:https://github.com/orgs/github/teams/justice-league/discussions/1

node_idstringrequired

Example:MDE0OlRlYW1EaXNjdXNzaW9uMQ==

numberintegerrequired

The unique sequence number of a team discussion.

Example:42

pinnedbooleanrequired

Whether or not this discussion should be pinned for easy retrieval.

Example:true

privatebooleanrequired

Whether or not this discussion should be restricted to team members and organization administrators.

Example:true

team_urlstring(uri)required

Example:https://api.github.com/organizations/1/team/2343027

titlestringrequired

The title of the discussion.

Example:How can we improve our workflow?

updated_atstring(date-time)required

Example:2018-01-25T18:56:31Z

urlstring(uri)required

Example:https://api.github.com/organizations/1/team/2343027/discussions/1

reactionsobject
Show Child Parameters
Example

Team Discussion Comment

object

A reply to a discussion within a team.

authorobjectrequired

Simple User

Show Child Parameters
bodystringrequired

The main text of the comment.

Example:I agree with this suggestion.

body_htmlstringrequired

Example:<p>Do you like apples?</p>

body_versionstringrequired

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

created_atstring(date-time)required

Example:2018-01-15T23:53:58Z

last_edited_atstring(date-time)required
discussion_urlstring(uri)required

Example:https://api.github.com/organizations/1/team/2403582/discussions/1

html_urlstring(uri)required

Example:https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1

node_idstringrequired

Example:MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=

numberintegerrequired

The unique sequence number of a team discussion comment.

Example:42

updated_atstring(date-time)required

Example:2018-01-15T23:53:58Z

urlstring(uri)required

Example:https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1

reactionsobject
Show Child Parameters
Example

Reaction

object

Reactions to conversations provide a way to help people express their feelings more simply and effectively.

idintegerrequired

Example:1

node_idstringrequired

Example:MDg6UmVhY3Rpb24x

userobjectrequired

Simple User

Show Child Parameters
contentstringrequired

The reaction to use

Allowed values:+1-1laughconfusedhearthoorayrocketeyes

Example:heart

created_atstring(date-time)required

Example:2016-05-20T20:09:31Z

Example

Team Membership

object

Team Membership

urlstring(uri)required
rolestringrequired

The role of the user in the team.

Allowed values:membermaintainer

Default:member

Example:member

statestringrequired

The state of the user’s membership in the team.

Allowed values:activepending

Example

Team Project

object

A team’s access to a project.

owner_urlstringrequired
urlstringrequired
html_urlstringrequired
columns_urlstringrequired
idintegerrequired
node_idstringrequired
namestringrequired
bodystringrequired
numberintegerrequired
statestringrequired
creatorobjectrequired

Simple User

Show Child Parameters
created_atstringrequired
updated_atstringrequired
organization_permissionstring

The organization permission for this project. Only present when owner is an organization.

privateboolean

Whether the project is private or not. Only present when owner is an organization.

permissionsobjectrequired
Show Child Parameters
Example