Skip to content

Reviews Object ​



id
string
REQUIRED · 

The unique identifier for the review

pull_request
object

The pull request this review belongs to

References: PullRequests → id
id
string

The unique identifier of the pull request

number
integer

The number of the pull request

status
string

The status of the review

All possible enum values:
  • approved
  • suggested_changes
  • commented
  • dismissed
  • pending
body
object

The body of the review

content
string

The content of the review body

format
string

The format of the body

All possible enum values:
  • markdown
  • html
  • plaintext
author
object

The author of the review

id
string

The unique identifier for the author

username
string

The username of the author

type
string

The type of the author

All possible enum values:
  • user
  • bot
commit
object

The commit that was reviewed

id
string

The SHA of the commit

url
string

The URL to view the commit in the browser

urls
object[]

URLs associated with the review

url
string

The URL

type
string

The type of the URL

All possible enum values:
  • review
  • pull_request
submitted_at
string · date-time

The date and time when the review was submitted

created_at
string · date-time

The date and time when the review was created

updated_at
string · date-time

The date and time when the review was last updated

remote_data
object

Raw data returned from the remote API call.