List the comments of the local user's pending review on a pull request. Local mode only.
GET
/pending-reviews
const url = 'https://example.com/api/v1/pending-reviews?url=example';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/api/v1/pending-reviews?url=example'Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters”url
required
string
The URL of the pull request.
Responses
Section titled “ Responses ”The pending review, or none.
Media typeapplication/json
object
repo
required
string
pull
required
integer
exists
required
False when you have no pending review on the pull request.
boolean
review_url
string
body
string
comments
required
Array<object>
object
id
required
integer format: int64
path
required
string
line
integer
excerpt
required
The first words of the comment.
string
speccy
required
True when Speccy wrote the comment.
boolean
Examplegenerated
{ "repo": "example", "pull": 1, "exists": true, "review_url": "example", "body": "example", "comments": [ { "id": 1, "path": "example", "line": 1, "excerpt": "example", "speccy": true } ]}default
Section titled “default”An error.
Media typeapplication/problem+json
RFC 9457 problem details with a stable code.
object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required
A stable machine-readable error code.
string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "code": "example"}