Appearance

List Reviews ​

Endpoint ​

http
GET /unified/ci-cd/reviews
Integrations supported
  • GitHub

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
owner

The slug of the owner on Github.

Required in
  • GitHub
repo

The slug of the repository on Github.

Required in
  • GitHub
pull_request
object

The pull request to filter reviews by.

Required in
  • GitHub
id
string
REQUIRED · 

The unique identifier of the pull request.

number
integer

The number of the pull request

Response Body ​

result
object[]

List of Reviews

id
string
REQUIRED · 

The unique identifier for the review

Supported in
  • GitHub
pull_request
object

The pull request this review belongs to

References: PullRequests → id
Supported in
  • GitHub
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
Supported in
  • GitHub
body
object

The body of the review

Supported in
  • GitHub
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

Supported in
  • GitHub
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

Supported in
  • GitHub
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

Supported in
  • GitHub
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

Supported in
  • GitHub
created_at
string · date-time

The date and time when the review was created

Supported in
  • GitHub
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.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.

debug
object

Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. null for static responses or when truto_skip_api_call=true.

requestUrl
string
requestOptions
object
data
responseHeaders
object
nextCursor
string
isLooping
boolean
isEmptyResult
boolean
resultCount
number