List Reviews

GET /unified/ci-cd/reviews

GitHub

Query Parameters

Refer Specifying query parameters in Truto APIs

owner

The slug of the owner on Github.

1 supported1 required

GitHub

required

repo

The slug of the repository on Github.

1 supported1 required

GitHub

required

pull_requestobject

The pull request to filter reviews by.

References: PullRequests → id

1 supported1 required

GitHub

required

idstring

required·

The unique identifier of the pull request.

Show Truto-specific parameters

integrated_account_idstring · uuid

required·

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

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

truto_response_formatstring

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.

Example: unified

Possible values:

unifiedrawnormalizedstreamdebug

truto_key_bystring

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_limitboolean

Ignores the limit query parameter.

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

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

remote_queryRecord<string, any>

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

Response Body

debugobject

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.

data

isEmptyResultboolean

isLoopingboolean

nextCursorstring

requestOptionsRecord<string, any>

requestUrlstring

responseHeadersRecord<string, any>

resultCountnumber

next_cursorstring

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.

resultobject[]

List of Reviews

idstring

required·

The unique identifier for the review

1 supported

GitHub

supported

authorobject

The author of the review

1 supported

GitHub

supported

3 properties

idstring

The unique identifier for the author

typestring

The type of the author

Possible values:

userbot

usernamestring

The username of the author

bodyobject

The body of the review

1 supported

GitHub

supported

2 properties

contentstring

The content of the review body

formatstring

The format of the body

Possible values:

markdownhtmlplaintext

commitobject

The commit that was reviewed

1 supported

GitHub

supported

2 properties

idstring

The SHA of the commit

urlstring

The URL to view the commit in the browser

created_atstring · date-time

The date and time when the review was created

1 supported

GitHub

supported

pull_requestobject

The pull request this review belongs to

References: PullRequests → id

1 supported

GitHub

supported

2 properties

idstring

The unique identifier of the pull request

numberinteger

The number of the pull request

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The status of the review

Possible values:

approvedsuggested_changescommenteddismissedpending

1 supported

GitHub

supported

submitted_atstring · date-time

The date and time when the review was submitted

1 supported

GitHub

supported

updated_atstring · date-time

The date and time when the review was last updated

urlsobject[]

URLs associated with the review

1 supported

GitHub

supported

2 properties

typestring

The type of the URL

Possible values:

reviewpull_request

urlstring

The URL

curl -X GET 'https://api.truto.one/unified/ci-cd/reviews?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'

const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/ci-cd/reviews?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.truto.one/unified/ci-cd/reviews"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())

import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'ci-cd',
  'reviews',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);

import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    async for item in truto_api.unified_api.list(
        "ci-cd",
        "reviews",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())